Step 1: Generate API Key in Breathe HR

Step 2: Upload Breathe HR API Key

Step 3: Confirmation

Some points to consider before integrating:

  1. Departments: Employees will be auto-allocated into their respective teams on the Perkbox platform.

  2. All 'active' people on Breathe HR will be added to Perkbox: We do not filter out people who should not receive Perkbox access based on their employment status (i.e. contractor) or their region. However, if you use an additional system with Breathe HR, such as Okta or Microsoft Azure, it could be possible. Please speak to your IT for this.


Step 1: Generate API Key in Breathe HR

If you are an admin of your Breathe HR instance, log in and select the "Configure" option in the top menu of the Breathe HR console, then select "Settings" in the drop down menu.

Under "Integrations", select "API Setup".

Select "Enable API".

Verify that you'd like to enable the API to access user information.

Save the generated production key. You'll upload this key in the next step.


Step 2: Upload Breathe HR API Key

To upload the API Key, you must log into your Perkbox Admin Portal to access the setup flow.


Step 3: Confirmation

Once the API Key is uploaded, your starters and leavers will be automated on Perkbox, centralising the control straight from Breathe HR.

Did this answer your question?