An API key lets other applications connect to your Crelate account, and admins control who can have one. API access is available on Business and higher subscriptions. For developer documentation, visit the Crelate API documentation page.
How do you turn on API access for non-admin users?
API access is always available to admins. For non-admins, an admin must allow API Access in their user role, which lets users in that role request and use API keys. API Access is turned off by default.
Go to Security, then select User Roles.
Select the user role you want to update.
In the Misc section, set API Access to Allowed.
Click Save.
How do you turn off API access for a user role?
Set API Access to No for the role and click Save. Users with that role no longer see API Access in their settings and cannot use the API. Existing connections that use their keys also stop working.
How do you get an API key?
Once API access is allowed for your user role, you can generate your own API key from Your Profile & Preferences.
Open the navigation menu and select Your Profile & Preferences.
Go to the API Access section.
Turn on the Enable API Access switch. The first time you turn it on, Crelate generates your API key automatically.
Do all users use the same API key?
No. Each user generates their own API key in Your Profile & Preferences, and every user’s key is different.
Your organization can still use a single API key for all of its connections. In that case, one user sets up the connections with their own key, and the connections exist under that user’s account. Do not share that key with other users.
Users can also set up their own connections with their own keys. Because each key is linked to one user, admins can see which user is making which calls. For example, one user can connect Salesforce with their own key, and another user can connect HubSpot with a different key.
If a user regenerates their key or turns API access off, or if an admin clears the key, every connection that uses that key stops working. This matters most when one user’s key powers all of the organization’s connections.
How do you regenerate an API key?
Click Regenerate New Key in the API Access section to replace your current key. Regenerating is the only way to create a new key after your first one. The old key no longer works, so any connection that uses it stops working. After you regenerate your key, update every connection with the new key.
💡 Pro Tip: Before you regenerate your key, list every connection that uses it, such as Zapier or other integrations. Each one must be updated with the new key, or it will stop working.
What happens when you turn off your API access?
Existing connections that use your key stop working until you turn API access back on. Turning API access off does not change your key. When you turn it back on, the same key is active again, and your connections work again without any updates.
Open the navigation menu and select Your Profile & Preferences.
Go to the API Access section.
Turn off the Enable API Access switch.
In the Toggle API Access window, click Yes to confirm. The window warns that existing integrations will fail.
To turn API access back on, turn on the Enable API Access switch again.
How do admins manage API access?
Admins can see every user with API access and turn off any user’s key from API Access in Security.
Go to Security, then select API Access.
In the Users with API Access list, select a user. The user’s masked API key appears in the Api Key field.
Click Clear API Key to turn off that user’s API access.
Clearing a key causes any connection that uses it to stop working. If the user needs API access again, they must generate a new key.
💡 Pro Tip: Before you clear a user’s API key, check the Webhooks section for Zapier triggers registered to that user. Clearing the key stops those triggers from working.
How do admins view and manage webhooks?
The Webhooks section on the API Access page lists every webhook in your organization, including webhooks an admin added and triggers that Zapier registered. Select a user in the Users with API Access list to see only that user’s webhooks. The list shows the following details.
Column | What it shows |
Name | The name of the webhook. |
Entity Type | The record type that triggers the webhook: Contacts, Companies, or Jobs. |
Operation Type | The operation that triggers the webhook: Create, Update, or Delete. |
Status | Whether the webhook is On or Off. A webhook that is Off does not send information when triggered. |
Url | Where Crelate sends information. |
To manage a webhook, select its row and use the icons next to Webhooks.
Turn a webhook on or off: Select Activate/Deactivate the selected webhook.
View details: Double-click the row. The details are read-only, so to change a webhook, delete it and add a new one.
Delete a webhook: Select Delete the selected webhook, then confirm. You cannot undo this.
Webhooks are available on Business Plus and Enterprise plans, and only an admin can add one. For setup steps, see Configuring Webhooks.
Can you connect AI clients without an API key?
Yes, if your organization has MCP enabled. You can connect AI clients such as Claude, Cursor, and VS Code to Crelate with the Model Context Protocol (MCP) instead of an API key. To get started, click Go to AI / MCP Access on the API Access page.
Note: AI / MCP Access is available only to organizations that have MCP enabled.