API Key Authentication

Obtaining API Keys

• Sandbox or Production API Keys

  To obtain an API key, visit the Dev Center and generate a Sandbox or Production key.

• Production Keys

  Production API keys require approval. Please contact our Sales team.

📘

Who generates the key matters!

API keys are tied to the user who generates them, meaning the key's capabilities depend on that user’s role and license. For instance, certain actions are exclusive to Org Admins — superusers with full access to the organization.

To ensure the API key has the necessary permissions for your needs, make sure it's generated by a user with the appropriate level of access.

🚧

Important: User removal deactivates their API Keys

If a user is removed from the workspace, any API keys they generated will be deactivated. Ensure that keys tied to critical operations are created by stable, long-term users with the necessary permissions.

How to use API Key Authentication

Add the following header to all your API requests:

Authorization: API-Key {{api_key}}

Example:

Authorization: API-Key 3039ba033eb1410caa0a2227158d63c9d6502cd8