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 go to Configure > Settings > Integrations > API Setup

What's available with the API?

absences
benefits
bonuses
change_requests
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

Does Breathe integrate with Sage, Xero or any other payroll? 

Currently the answer is no. We're waiting on the payroll companies to open up their API. We're super excited for this to happen and will jump at the chance when it becomes available.

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 pop over to https://developer.breathehr.com/ when you can find all the resources you require and what is included.

Did this answer your question?