What is an API and how can it benefit you?
A public API is a tool that allows you to automate and streamline everyday HR processes. With it, you can integrate Calamari with other systems your company already uses. The API facilitates the automatic exchange of data, eliminating the need for manual input or logging into the system. Think of it as building a bridge between Calamari and other tools, enabling seamless cooperation.
By integrating Calamari through the API, you can, for instance, transfer information about requests, track work hours, or automate recurring report generation and delivery.
Since a public API requires an infrastructure capable of sending requests to the application, we recommend involving your IT department to effectively link Calamari with your other applications.
You can find all the necessary details for building an integration using our API on developers.calamari.io.
What is an API key?
An API key is an identifier used to connect Calamari with an external system. Calamari’s API provides access at the organization account level. To use the Calamari API integration, you need to generate an API key.
Where can I find an API key?
Go to Configuration Panel → API Integration → Enable.
Once the integration is enabled, you'll have the option to generate as many API keys as you need.
Creating a new API key
When creating a new API key, you can choose whether the key will allow communication with all available API endpoints or only specific functionalities. Please remember that Calamari’s public API operates at the organization account level, not in the context of a specific user.
⚠️ Important!
When you click Generate Key, the API key will only be displayed once, allowing you to copy it and use it in your integration tool. This enhances security, as the key cannot be retrieved again by any administrator.
Each time you disable and re-enable the API integration, your API key will change. This may affect the functionality of existing integrations.
Example of a key granting access to all endpoints of our public API.
Example of a key restricted only to current shift status:
💡 Looking for a solution that works in the context of a specific user?
MCP Server operates in the context of an individual user. It may be a better solution when an employee or manager wants to use Calamari through a compatible AI tool. Access remains aligned with the user’s role and permissions in Calamari.
MCP Server supports selected actions, so it may not replace an integration built with the public API in every case.
API Documentation
Our documentation developers.calamari.io provides a detailed description of each endpoint, including the specific scopes (e.g., Absence Requests, Holidays, etc.).
The guideline rules and information about returned messages are described in the Usage Guidelines: https://developers.calamari.dev/pages/usage-guidelines
Managing API keys
The application interface allows you to check basic information about the API keys you’ve generated.
Additionally, if a key hasn’t been used for over 12 months, the system will suggest verifying whether it’s still needed.
