API keys authorize applications to securely access ClearPoint data and functionality without requiring a user’s password.
What Are APIs and API Keys?
An API (Application Programming Interface) allows different applications to communicate with each other. It sends requests, retrieves the needed information, and returns responses. To learn more, see our ClearPoint API support article.
API Keys authorize an external application to access ClearPoint “on behalf of” a specific user—without exposing that user’s password.
🔎 Note:
API Keys and Data Loader Keys are now separate.
For Data Loader Keys, see Data Loader 2.0.
Creating an API Key
To generate a new API Key:
From the top navigation, click Settings.
Choose Integrations.
Navigate to the API Keys tab.
Click the Add API Key (+) icon.
Configure the API Key
Enter an API Key Name — for example, Integration.
We recommend using the name of the application that will use the key.
Under Expires, set an expiration date.
Use the Mapped User Account dropdown menu to select a user account.
Only elements visible to this mapped user will be accessible through the key.
Click Save.
Your new key will appear in the API Keys list.
💡 Note:
When an API Key is used, all actions appear in Revision History under the mapped user’s name.
Managing API Keys
From the API Keys list, you can edit, view, or delete existing keys.
Edit an API Key
Click the kebab menu (⋮) and select Edit API Key.
From the Edit API Key drawer, you can:
Key name
Expiration date
Mapped user
Click Save.
Delete an API Key
If a key is no longer needed or you suspect it is compromised:
Click the kebab menu (⋮) and select Delete API Key.
Confirm by clicking the red Delete button.
💡 Deleting a key immediately disables access through that key.
Using Your API Keys
ClearPoint API Keys consist of two parts:
API Key
Secret Key
To use the API Key, include both as request headers in your HTTP calls:
🚨 Important:
Treat these keys like passwords—they grant access to your account and should never be shared.
API Key Security Best Practices ⚠️
Treat API Keys as sensitive credentials.
Delete keys immediately when they are no longer needed.
Regenerate keys if you suspect misuse.
Assign the mapped user with the minimum required permissions.
Use expiration dates to reduce long-term exposure risk.
To delete a compromised key:
Go to Settings.
Choose Integrations.
Navigate to the API Keys tab.
Click the kebab menu (⋮) and select Delete API Key.
Confirm deletion.
