Developers · REST API
API keys and scopes
Create a key, pick its scopes and revoke it.
On this page
Open SettingsAPI keys and click Create key
Workspace admins can create keys.
Name it and choose its scopes
Name it after the system that will use it, such as “CRM sync”. Tick only the scopes it needs.
Copy the key
It starts with
sk_live_and is shown once. Store it in your secrets manager.
Use the key
curl https://api.example.com/api/v1/contacts?limit=10 \ -H "Authorization: Bearer $CODIQUE_API_KEY"Scopes
A key can do only what its scopes allow: the same permissions a team member’s role grants.
| Area | Scopes |
|---|---|
| Inbox | inbox:read inbox:send inbox:upload inbox:assign |
| Contacts | contact:read contact:create contact:edit contact:delete contact:import contact:export |
| Templates | template:read template:create template:edit template:delete template:sync |
| Campaigns | campaign:read campaign:create campaign:send campaign:cancel |
| Workflows | workflow:view workflow:execute |
| Tags | tag:read tag:create |
| Webhooks | webhook:read webhook:create |
Revoke a key
Revoke it from the same screen. It stops working immediately. The list shows when each key was last used, which helps you find keys nobody needs any more.
Still stuck? Contact us with what you were doing and the exact message you saw.