API Keys
Create and manage API keys for programmatic access to your organization's data and integrations.
API Keys
Create and manage API keys for programmatic access to your organization's data and integrations.
API Key List
The API Keys page provides a searchable view of the keys associated with your organization. The interface adapts to desktop and mobile screens and shows empty, loading, or error states when applicable.
| Element | What it does |
|---|---|
| Search bar | Finds API keys by name. |
| All Keys count badge | Shows the total number of API keys. |
| Desktop table | Displays key details in a table layout. |
| Mobile list | Displays key details in a mobile-friendly list. |
| Pagination | Lets you browse multiple pages of keys. |
Creating an API Key
Managing API keys requires the company settings permission for API keys.
Click Add new key
Select Add new key on the API Keys page to open the key creation form.
Enter a key name
Enter a descriptive name for the key. A key name is required.
Click Add
Select Add to create the API key.
Copy and store the generated key
Copy the generated key and store it in a secure location, such as your organization's secrets manager.
Copy and store the generated key securely. The key may not be shown again after creation.
API Documentation
Use the API documentation link on the API Keys page when integrating your organization's data and integrations with the API.
Premium Plan Gating
API access requires the Premium plan, monthly or yearly, or a trial. Without API access, the page displays a Premium Feature lock screen. Users with subscription management permission see an Upgrade plan button.