Back

Create API keys for the Factorial IT API

A Factorial IT API key authenticates the calls you make to the Factorial IT API, a REST API. Create one when you want an integration or script to read or change your data through the API.


 

Feature/Functionality

Overview

Keys authenticate requests to the Factorial IT API (REST). There are two kinds, each with its own reach:

  • Company API key. Limited to one company. It opens every endpoint that works on company-level resources: devices, employees, accessories, tickets, SaaS and more.
  • Workspace API key. Covers your whole workspace. It opens the workspace-level endpoints, for example listing and viewing the companies in your workspace.

Most endpoints need a Company API key. Only the workspace endpoints (under /workspace/) need a Workspace API key. The API reference shows a badge on each endpoint with the type it expects.

 

How to use: create a Company API key

  1. Go to Settings > Developers.
  2. Click Create key.
  3. Type a Key name of 4 characters or more, for example "My integration".
  4. Set the Access level to Read-only or Read/write.
  5. If you want, set an Expiration (days). Leave it blank for a key that never expires.
  6. Click Create key, then Copy secret. The secret is only shown this once.

Keep the key somewhere safe. Anyone holding it can reach your data through the API.

 

Use the key

Send the key in the Authorization header of each request:

curl https://api.getFactorial IT.com/v1/devices \
  -H "Authorization: Bearer YOUR_API_KEY"

 

Revoke a key

  1. Go to Settings > Developers and find the key under Factorial IT API keys.
  2. Open the ⋯ menu on its row and click Revoke.
  3. Confirm.

The key stops working at once and cannot be brought back. Revoked keys remain in the list so you can trace them. To remove one for good, open its ⋯ menu and click Delete.

 

View API logs

After your company has sent its first request, a See API logs card shows on the Developers tab. Click it to open API logs. The page lists the last 50 REST and MCP requests for your company. The Actor column shows the key, MCP client or employee behind each one.


 

Tips and Best Practices

  • Choose Read-only unless the integration must write. Give each key the lowest access level that works.
  • Set an expiration for temporary integrations. A key that never expires stays a risk until someone revokes it.
  • Copy the secret straight away. It is not shown again.
  • Use one key per integration. A clear name tells you what stops working when you revoke it.
  • Check the API logs. The Actor column shows who is calling the API.

 

Troubleshooting and FAQ

Troubleshooting

  • A workspace endpoint rejects your key. Endpoints under /workspace/ need a Workspace API key, not a Company API key.
  • A company endpoint rejects your key. Most endpoints need a Company API key. Check the badge on the endpoint in the API reference.
  • A write request fails. The key may be Read-only. Create a key with Read/write access.
  • An integration stopped working. The key may have been revoked or reached its expiration. Create a new key.
  • You do not see the See API logs card. It only appears once your company has made at least one request.

 

FAQ

  1. Can I see the secret again after creating the key?
    No. It is shown only once. If you lose it, create a new key.
     
  2. Can I restore a revoked key?
    No. It stops working at once and cannot be restored.
     
  3. Why are revoked keys still listed?
    For traceability. Use Delete in the ⋯ menu to remove one permanently.
     
  4. How many requests do the API logs show?
    The 50 most recent REST and MCP requests for your company.

Was this article helpful?

Give feedback about this article

Can’t find what you’re looking for?

Our customer care team is here for you.

Contact us

Knowledge Base Software powered by Helpjuice