How to Generate and Manage API Credentials for Personnel Data

Generate API Credentials

1. Go to Settings > INTEGRATIONS > API credentials.
2. Click on the Generate new credential button on the top right of the screen.
3. In the Add new credential sidebar that appears, enter a meaningful name (for example, Greenhouse Integration API Credentials) for the API credentials into the Name field. This name will be important if you need to re-access or remove the credentials.
4. Select the relevant integration from the Integration drop-down menu.
   Note: Selecting an integration does not automatically set up an integration.
5. The recommended permission access level for the Employees endpoint will be preselected and can be adjusted via the Read or Write permission checkboxes. Note: If you select Write when adding an integration, the integration that is to be added will be permitted to create and update data in Personio.
6. The recommended permission access level for the Absences and Attendances endpoints will be preselected, and can be adjusted via the Read or Write checkboxes.
   Note: It is not possible to select the data that should be transferred from Personio via the Absences and Attendances endpoints. For more information, see Getting Started with the Personio API.
7. The recommended permission access level for the Documents endpoint will be preselected, and can be adjusted via the Read and Write checkboxes. The Documents endpoint allows the upload of documents to Personio. It does not allow the credential holder to retrieve documents from a Personio account. Note: The Documents endpoint requires Read permission to retrieve the Document Category ID which is needed to push documents to Personio via the Write permission.
8. The relevant attributes (for example, Name, Email and Department) that should be transferred from Personio to the integration via the Employees API will be preselected in the Readable employee attributes drop-down menu. If necessary, you can adjust the access permissions via the checkboxes in the Readable employee attributes drop-down menu. For more information about the access permission level that needs to be assigned for a specific integration, read Integrations.
9. To generate the API credentials (client ID and secret credentials), click on the Generate new credential button. A message will display confirming that the credentials have been created.