Skip to main content
Primo API keys authenticate requests to the Primo REST API. There are two types of API keys, each with a different scope.

​
API key types

​
Company API key

A Company API key is scoped to a single company. It gives access to all endpoints that operate on company-level resources — devices, employees, accessories, tickets, SaaS, and more.

​
Workspace API key

A Workspace API key is scoped to your entire workspace. It gives access to workspace-level endpoints, such as listing and viewing the companies within your workspace.
Most API endpoints require a Company API key. Only the workspace-specific endpoints (under /workspace/) require a Workspace API key. Check the API reference for the badge on each endpoint.

​
Generate a Company API key

1

Go to Settings > Developers

2

Click Create key

3

Enter a key name

Enter a Key name of at least 4 characters (e.g. “My integration”).
4

Choose the access level

Choose Read-only or Read/write as the Access level.
5

Set an expiration

Optionally set an Expiration (days). Leave it empty for a key that never expires.
6

Create the key and copy the secret

Click Create key, then Copy secret — the secret is shown only once.
Store your API key securely. Anyone with this key can access your Primo data via the API.

​
Use the API key

Pass the key in the Authorization header of your requests:

​
Revoke a key

To revoke a key, go to Settings > Developers and find the key in Primo API keys. Open the ⋯ menu on its row and click Revoke, then confirm. The key stops working immediately and cannot be restored. Revoked keys stay listed for traceability. To remove one for good, open its ⋯ menu and click Delete.

​
View API logs

Once your company has made at least one request, a See API logs card appears on the Developers tab. Click it to open the API logs page. It shows the 50 most recent REST and MCP requests for your company, with the key, MCP client or employee behind each one in the Actor column.