API keys allow you to securely connect external applications to your system while keeping the same permission level as the user who created the key. This means any actions performed through the API follow the same access rules and restrictions as if they were done directly in the system.
API keys are typically used for integrations, reporting tools, or automated workflows that need ongoing access without requiring a user to log in manually.
You can find the full technical documentation, including available endpoints and examples, via the Scalar API reference.
📌 Note: Some API features are currently under development and may not be available yet. Functionality will be expanded as enhancements are released.
Create an API key
Creating an API key allows an external application to authenticate with the system using secure credentials.
To create an API key, follow the steps below:
From the Admin area, click API Keys.
Unlock the green padlock icon.
Click Create New API Key.
Enter a clear description to help you identify how this key will be used.
Click Create Key.
Copy the Access Key, Secret Key, and API Advanced Details.
⚠️ Important: The secret key is displayed only once when the API key is created. Make sure you copy it immediately and store it securely. Anyone with access to this key can interact with the system using the same permissions as the user who created it, so only share API keys with trusted applications or services. If the secret key is lost, you will need to create a new API key.
Disable an API key
If an API key is no longer required, or if a user has left your organisation, you should disable the key to immediately revoke access.
To disable an API key, follow the steps below:
From the Admin area, click API Keys.
Unlock the green padlock icon.
Click Disable next to the API key you want to revoke.
Click Disable Key to confirm.
⚠️ Warning: Disabling an API key takes effect immediately. Any external applications using this key will no longer be able to authenticate or access the system.