| Note: The TalentHR API is available with Essential plan. For more information, read this article. |
By using the TalentHR public API you can have your code or application communicate and exchange data with your TalentHR domain. Access all your HR data, cleaned up and structured, immediately useful and valuable via a singular public API.
You can create multiple Public API keys and configure each one separately.
You can also make an API key Read-only, allowing an external integration to access TalentHR data without permitting it to make changes.
Through our API documentation, we offer an organized suite of API calls with descriptions and code examples to facilitate API interactions. A Postman collection is also seamlessly embedded within the API documentation.
To start using our public API:
1. Sign in to your TalentHR account as an Admin or an HR Manager, and go to Settings.
2. Select Domain settings.
3. Click on the API tab. All of your API keys are stored in this page.
For each key, you can see:
- Its Alias
- Its Public key
- Whether it is Read-only
- Whether it is Active
From this page, you can also:
- Copy a Public API key.
- Activate or deactivate it.
- Edit or Delete it.
You can generate multiple API keys and use a different key for each external system or integration. This lets you manage each integration independently and activate, deactivate, or configure its access when needed.
To generate a new API key:
1. While under the API tab, click Generate new.
2. Enter or edit the key's Alias. Using a descriptive Alias can help you identify which external system or integration uses the key.
3. Use the Active option to choose whether the key can currently be used.
4. Enable Read-only if the integration should be able to access TalentHR data without making changes.
5. Click Save.
What is a Read-only API key?
A Read-only Public API key can be used to access data through the TalentHR Public API, but it cannot be used to make changes to TalentHR data.
Read-only keys are useful when an external system only needs to retrieve information, for example for reporting, analytics, synchronization, or another integration where write access is not required.
Where possible, use a Read-only key for integrations that do not need to create, update, or delete TalentHR data.
| Note: The Active and Read-only settings serve different purposes. An Active Read-only key can access data but cannot make changes. An inactive key cannot be used by the integration. |
To change an existing API key to Read-only:
- Go to Settings → Domain settings → API.
- Locate the API key you want to update.
- Click the Edit icon.
- Enable Read-only.
- Click Save.
The Read-only column on the API page will show whether the setting is enabled for each key.
To restore write access to the key, edit it again, disable Read-only, and click Save.
| Note: Before changing an API key that is already being used by an integration to Read-only, make sure that the integration does not rely on operations that make changes in TalentHR. Once Read-only is enabled, those changes will no longer be permitted. |
To learn more about our TalentHR public API, check out our documentation here:
| Note: There’s a limit of 2000 API calls per 1 minute. In case the system detects too many API calls in a very short period, this limit might be reduced, or access to the API might be disabled. |