This article explains how to generate and manage credentials for Personio public APIs.
Learn about API credentials
APIs allow Personio to share data with other services or tools. API credentials act like a key. They control the flow of information and decide what gets shared. These credentials build connections and protect communication between applications.
Manage API credentials in Personio
In Personio, the system creates API credentials for the following:
-
- Recruiting API
- Integrations from Personio
- Integrations from Personio partners
You can't manage these credentials yourself. You can update these integrations through the Personio Marketplace. The system sets most API access rights to the level needed for the integration to work. You usually generate and manage API credentials manually for custom integrations.
Generate API credentials for custom integrations
Personio automatically creates API credentials for all integrations except custom ones. To generate credentials for custom integrations:
- Go to Marketplace > Connected Integrations.
- Click Create custom integration at the top right of the screen.
- Configure the setup.
| Integration access rights | Read permissions | Write permissions |
| Employees |
Allow third-party systems to pull data from Personio. |
Allow third-party systems to create and update data in Personio. |
| Attendances |
Allow third-party systems to pull data from Personio. |
Allow third-party systems to create, update, and delete data in Personio. |
| Absences |
Allow third-party systems to pull data from Personio. |
Allow third-party systems to create and update data in Personio. |
| Documents |
Allow third-party systems to pull document category IDs from Personio. |
Allow third-party systems to create documents in Personio. |
| Custom Reports |
Allow third-party systems to retrieve all existing custom reports from Personio. Check this box to make all attributes in a custom report retrievable. This applies even if they don't appear under Readable employee attributes. |
Not applicable. |
| Webhooks |
Retrieve webhook meta information. |
Create, update, and delete webhooks. Read and Write permissions don't affect whether a webhook triggers. A webhook keeps working after you create it, no matter the permission settings. Learn more about webhooks in our technical documentation. |
Manage API credentials for custom integrations
To update the access rights for custom integrations:
- Go to Marketplace > Connected integrations.
- Click the integration to update.
- In the window that appears, make your changes.
- Save your settings.
You can also reset the API credentials from here by following the instructions.
Disconnect or disable API credentials
- Go to Marketplace > Connected integrations.
- In the Action column, click the three dots.
- Click Disable to temporarily disable credentials.
- Click Disconnect to permanently delete credentials.
Access technical documentation
Find all API documentation in our Developer Hub. This includes endpoints, webhooks, data details, and tutorials. The Developer Hub has two versions with different content. Webhook information is in version 2.0. To switch versions, click the version number at the top of the home page.