Integrating Breathe HR with Perkbox helps keep your employee list up to date automatically.
Once connected, Perkbox will:
Add new starters
Remove leavers
Assign employees to the correct teams
All changes are driven directly from Breathe HR, reducing manual admin and helping ensure your Perkbox account reflects your current workforce.
Before you begin, make sure you:
Are an admin in Breathe HR
Have admin access in Perkbox
Before you integrate – important things to know
Departments and teams
Employees are automatically allocated to their corresponding teams in Perkbox based on their department data in Breathe HR.
Who gets access to Perkbox
All active people in Breathe HR are added to Perkbox.
This includes:
contractors
employees in all regions
Perkbox does not filter access based on employment type or location.
If you use an additional system alongside Breathe HR, such as Okta or Microsoft Azure, more advanced access control may be possible. For this, we recommend speaking with your IT team.
Generate an API key in Breathe HR
Step one – Log in to Breathe HR as an admin.
Step two – From the top menu, select Configure, then select Settings from the dropdown.
Step three – Under Integrations, select API Setup.
Step four – Select Enable API.
Step five – Confirm that you want to enable API access to user information.
Step six – Save the production API key shown on screen.
You’ll need this key to complete the setup in Perkbox.
Important: Keep this API key secure. You’ll only need to upload it once.
Upload the Breathe HR API key to Perkbox
Step one – Log in to the Perkbox admin portal.
Step two – Go to Integrations from the left-hand menu.
Step three – Open the Breathe HR integration.
Step four – Paste the API key you generated in Breathe HR into the setup field.
Step five – Save and continue to complete the setup.
Confirmation
Once the API key is uploaded and the integration is enabled:
Starters and leavers are automatically synced from Breathe HR
Team allocation is managed centrally from Breathe HR
No ongoing manual updates are needed in Perkbox
Your Breathe HR integration is now active.