Prerequisites
To create an API key, you must be an admin in the PeopleHR system. To check that you have the required permissions:
- Click on access in the top left corner of your screen
- Ensure that you can see HR Admin in the available products
Creating an API Key
- In the sidebar of the HR Admin product, press on Settings, and then click on API
- Click the + icon, and enter a name for the API key
- Select the relevant scopes for the API key based on which data the integration requires:
- If you want to enable reading or writing employee data, enable Employee
- If you additionally want to enable reading employee's salary data, enable Salary
- If you want to enable reading or writing absence data, enable Absence and Holiday
- Click Save
- Paste the created API token into the connection flow