Using the API Key
Include the API key in theAuthorization header using the Bearer scheme:
Key Management
- Key types: Each key is either Read-Only or Full Access. A Read-Only key can only make
GETrequests. A Full Access key can also create, update, and delete data withPOST,PATCH, andDELETErequests. - Type set at creation: You choose a key’s type when you create it, and it cannot be changed afterwards. To change access, create a new key and delete the old one.
- No expiration: API keys are valid indefinitely until explicitly revoked.
- Revocation: Delete a key from Settings > API Keys in your workspace to revoke it. Revocation is permanent and takes effect within a few seconds — after that, any request using that key will return
401.
Security Best Practices
- Store keys securely: Use environment variables or a secrets manager. Never hard-code keys in source code.
- Server-side only: API keys should only be used in server-side code. Never expose them in client-side JavaScript, mobile apps, or public repositories.
- Rotate periodically: Create a new key, update your integration, then delete the old one.
Errors
401 Unauthorized
The API key is missing, malformed, or does not match a valid key:403 Forbidden
A Read-Only API key was used for aPOST, PATCH, or DELETE request: