---
title: How to integrate with Breathe HR
description: A step by step guide detailing how to set up an integration between Ravio and Breathe HR
---
[Skip to content](https://help.ravio.com/breathe-hr#main-content)
English
Show submenu for translations
Open main navigation
Close main navigation
- English
Show submenu for translations
- [Contact us](https://fa3fd.share-eu1.hsforms.com/2IkfMVpstTUWvffP5uESSLg)
[Contact us](https://fa3fd.share-eu1.hsforms.com/2IkfMVpstTUWvffP5uESSLg)
How can we help you?
- There are no suggestions because the search field is empty.
1. [Ravio Help Centre](https://help.ravio.com/?hsLang=en)
2. [Integrations and data sharing](https://help.ravio.com/integrations-and-data-sharing?hsLang=en)
3. [Setting up your HRIS integration](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#setting-up-your-hris-integration)
# How to integrate with Breathe HR
## A step by step guide detailing how to set up an integration between Ravio and Breathe HR
### Prerequisites
Please carefully read the following to make sure you fulfil all the requirements to set up the integration:
**Your account must belong to the “HR user" organisational role in your company's Breathe HR instance.**
To check this is the case for your user, follow the below instructions.
- Log into Breathe HR and click on the "**Configure**" tab in the top navigation bar, and then click on "**Settings**" in the drop-down.
****
- Locate the "**API Setup**" tab in the "**Settings**" page under "**Integrations**". If you can see this option you have the correct permissions and can continue.
If you cannot see the "**API Setup**" tab (or any other tabs from these instructions), it means that your account does not belong to the "**HR user**" role. Please reach out to your company’s Breathe HR administrator who will be able to assign you this role or alternatively complete the integration themselves.
### Step by Step Instructions
#### Step 1 - Navigate to the Breathe HR tile in Ravio
In the Ravio onboarding flow, select the tab marked Breathe HR.
#### Step 2 - Locate the Production API key
Navigate to Configure \> Settings and go to ‘API Setup’ in the ‘Integrations’ section of the menu.
Copy the Production API Key from the page that appears.
Please make sure that the value you copied is the **Production API Key** and NOT the Sandbox API Key.
#### Step 3 - Copy the Production API Key into Ravio
Paste the key into the connection flow, and then click on "**Set up integration**":
### Limitations
Certain fields that are visible in Breathe HR are not exposed by their API, for example Pay Grade or FTE.
Their documentation on what is and is not exposed can be found [here.](https://developer.breathehr.com/examples)
To work around this we may require you to create a custom field that replicates this information. This field will need to be kept up to date along with the existing field. If you need any help doing this please contact us, we are happy to advise!
- [Getting started](https://help.ravio.com/getting-started?hsLang=en#main-content)
- [Onboarding](https://help.ravio.com/getting-started?hsLang=en#onboarding)
- [Benchmarking](https://help.ravio.com/getting-started?hsLang=en#benchmarking)
- [Pay equity](https://help.ravio.com/getting-started?hsLang=en#pay-equity)
- [Video guides](https://help.ravio.com/getting-started?hsLang=en#video-guides)
- [Using Ravio with AI tools](https://help.ravio.com/getting-started?hsLang=en#using-ravio-with-ai-tools)
- [Integrations and data sharing](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#main-content)
- [Setting up your HRIS integration](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#setting-up-your-hris-integration)
- [Variable and equity data](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#variable-and-equity-data)
- [Manually sharing employee data](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#manually-sharing-employee-data)
- [Setting up your ATS integration](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#setting-up-your-ats-integration)
- [Managing your integration](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#managing-your-integration)
- [Video guides](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#video-guides)
- [Ravio feature guides](https://help.ravio.com/ravio-feature-guides?hsLang=en#main-content)
- [Salary bands](https://help.ravio.com/ravio-feature-guides?hsLang=en#salary-bands)
- [Explore the market](https://help.ravio.com/ravio-feature-guides?hsLang=en#explore-the-market)
- [Employee mapping & levelling](https://help.ravio.com/ravio-feature-guides?hsLang=en#employee-mapping-levelling)
- [Manage my data](https://help.ravio.com/ravio-feature-guides?hsLang=en#manage-my-data)
- [Settings](https://help.ravio.com/ravio-feature-guides?hsLang=en#settings)
- [Analyse your company](https://help.ravio.com/ravio-feature-guides?hsLang=en#analyse-your-company)
- [EU Pay Transparency](https://help.ravio.com/ravio-feature-guides?hsLang=en#eu-pay-transparency)
- [User and access management](https://help.ravio.com/user-and-access-management?hsLang=en#main-content)
- [User permissions](https://help.ravio.com/user-and-access-management?hsLang=en#user-permissions)
- [Single Sign On (SSO)](https://help.ravio.com/user-and-access-management?hsLang=en#single-sign-on-sso)
- [Benchmarking and data confidence](https://help.ravio.com/benchmarking-and-data-confidence?hsLang=en#main-content)
- [Data](https://help.ravio.com/benchmarking-and-data-confidence?hsLang=en#data)
- [Troubleshooting and support](https://help.ravio.com/troubleshooting-and-support?hsLang=en#main-content)
- [Contact support](https://help.ravio.com/troubleshooting-and-support?hsLang=en#contact-support)
- [FAQ](https://help.ravio.com/faq?hsLang=en#main-content)
- [Billing and invoices](https://help.ravio.com/faq?hsLang=en#billing-and-invoices)
- [Compliance](https://help.ravio.com/faq?hsLang=en#compliance)
- [Ravio community](https://help.ravio.com/faq?hsLang=en#ravio-community)
- [Sales](https://help.ravio.com/faq?hsLang=en#sales)
- [Integrations](https://help.ravio.com/integrations?hsLang=en)
- [Uncategorized](https://help.ravio.com/uncategorized?hsLang=en)
- Home
- Products
- Pricing
- Blog
- Company
[](http://ravio.com)
[mailto:hello@ravio.com](mailto:hello@ravio.com)
Copyright © 2026, Ravio Technologies Ltd