This article applies specifically to organizations using the HRIS Sync integration.
Overview
This guide will outline the steps needed to connect your Breathe account. To connect your Breathe account, you will need to provide an API key.
Prerequisites
You are an Administrator in your company's Breathe instance, or someone has shared their access with you.
Instructions
Step 1: Find your production API key
- Log in to your Breathe account
- Click Configure in the bottom left corner
- Click Settings in the panel that opens
- Click API Setup in the bottom right
- Click Enable API if you haven't already done so in the past. Agree to the terms that pop up on the subsequent screen.
- Copy your production API key
Step 2: Enter your production API key in the linking window
Fields ContactMonkey can sync from Breathe
When you connect Breathe with HRIS Sync, ContactMonkey can pull the fields below into your Directory. A field only fills in if it has a value in Breathe and the account you used to connect has permission to read it.
Employee fields
| Field | What it contains |
|---|---|
| First name | The employee's first name. |
| Last name | The employee's last name. |
| Full name | The employee's full name. Uses the preferred first name when one is available. |
| Work email | The employee's work email address. |
| Personal email | The employee's personal email address. |
| Mobile phone number | The employee's mobile phone number. |
| Profile photo | A link to the employee's profile photo. |
| Employee number | The employee number shown in your HRIS. |
| Employment status | Whether the employee is active, pending or inactive. |
| Start date | The date the employee started. For rehired employees, this is the most recent start date. |
| Termination date | The employee's termination date. |
| Date of birth | The employee's date of birth. |
| Gender | The employee's gender. |
| Ethnicity | The employee's ethnicity. |
| Marital status | The employee's filing status as related to marital status. |
Fields not available from Breathe
Breathe doesn't share these fields through HRIS Sync: Preferred first name, Username, Record created date, Manager, Groups, Work location, Home address, Social security number.