What is the API?
The API allows you to connect Breathe to an external system of your choice.
This involves building a piece of code that connects the two systems, so you will need to find a developer internally or externally to build this 'link'.
Below you will find a document explaining the API and how it works. It'll be down to your development team when it comes to using this - but more information can be found here if it's needed.ย
To enable your API head to Configure > Settings > Integrations > API Setup
โ
Please note: Due to the fact that the API is open and has access to sensitive information this can only be actioned by the Admin of the account.
Areas in Breathe that can be connected to with the API include
Absences
Benefits
Bonuses
Change requests
Custom Fields
Departments
Divisions
Employee expense claims
Employee expenses
Employee training courses
Employees
Holiday allowances
Leave requests
Locations
Other leave reasons
Salaries
Sicknesses
Statutory holiday countries
Working patterns
Where can I find help with the API?
We do not support the use of the API at Breathe so are unable to offer guidance on its usage so we would encourage you to head over over to https://developer.breathehr.com/ where you can find all the resources you require.