API Keys
Create and manage your own keys in Settings → API Keys.
Create a key
Section titled “Create a key”- Select Create API key and enter a name.
- Keep your current role or choose another available role.
- Choose an expiration date and time, then select Create key.
- Use the copy icon to save the full key. It is shown only once.
- Check I have saved this key securely and select Done.
Roles and access
Section titled “Roles and access”All user roles can create their own keys. A key cannot have more permissions or access to more records than you. Roles that exceed your access are not available.
You select a role for the key; you do not edit individual permissions here. Changes to your access can also affect the key.
Expiration
Section titled “Expiration”Every key needs a future expiration date, no more than 365 days from now. There is no Never option. The date picker uses your local time; the list shows dates in your organization’s reporting timezone.
Edit or revoke
Section titled “Edit or revoke”Edit: Change the name, role or expiration, then select Save changes. The saved key stays the same.
Revoke: Select Revoke, then Revoke key to confirm. The key stops working and cannot be restored.
Expired and revoked keys cannot be edited or reactivated. Create a new key if needed.
Status
Section titled “Status”| Status | Meaning |
|---|---|
| Active | Not expired or revoked; access still depends on permissions. |
| Expired | The expiration date has passed. |
| Revoked | The key has been permanently disabled. |
| Role removed | The assigned role no longer exists; the key cannot be used. |
Replace a key
Section titled “Replace a key”Create a new key, update your integration, confirm it works, then revoke the old key. If a key is exposed, revoke it immediately.
The shortened identifier in the list is not the full key. If you lose the full key, create a replacement.