Create an API key
Name the key
Enter a descriptive name that identifies how the key will be used — for example,
Production Backend or CRM Integration.Set an expiry date (optional)
Choose an expiry date if you want the key to automatically deactivate after a set period. Leave blank for no expiry.
Choose permissions
Select the resources and permission levels this key needs. You must grant at least one permission.
Resource permissions
Each API key is scoped to specific resources. You can grantread, write, or both permissions per resource.
| Resource | Description |
|---|---|
calls | Read/write access to call history |
leads | Read/write access to lead data |
agents | Read/write access to agent configuration |
analytics | Read access to analytics data |
contacts | Read/write access to contacts |
knowledge_base | Read/write access to the knowledge base |
integrations | Read/write access to integration settings |
read — allows GET requests to list and retrieve records for that resource.
write — allows POST, PATCH, and DELETE requests to create, modify, and remove records for that resource. Write access does not automatically include read; grant both if needed.
The
analytics resource supports read only. Write access is not available for analytics data.Use a key in API requests
Include your API key as a Bearer token in theAuthorization header of every request:
Revoke a key
To permanently deactivate a key:
Revoked keys appear in the Revoked / Expired section for audit purposes and cannot be reactivated.
Security best practices
- Never share keys publicly. Do not commit API keys to source control or expose them in client-side JavaScript.
- Use minimal permissions. Grant only the resources and permission levels each integration actually requires.
- Set an expiry date for keys used in short-term integrations or shared environments.
- Rotate keys regularly. Revoke and replace keys periodically, especially after team member changes.
- Monitor usage. Each key displays usage counts for the last 24 hours, 7 days, and 30 days — review these if you suspect unauthorized access.