# Breathe setup

Breathe connects through the **unified HRIS connector**. This page covers the
Breathe-side configuration you complete first. Once it's done, add the connector
in Mesh by following [Connect your HR system](../connect-your-hr-system.md).

You finish with one value: a **production API key**.

## Before you start

You need **administrator access** to your company's Breathe instance, or a
colleague who has it.

> **warning**

These steps reflect Axiad's current understanding of Breathe's configuration.
Because Breathe is a third-party product, there may be variations between your
experience and what this guide describes, depending on the version in use and
recent updates.

If you find a significant difference, or anything that doesn't make sense, let
us know through Axiad support.

## Step 1 — Open API setup

1. Sign in to Breathe and select **Configure** at the bottom left.

   ![The Breathe Configure action](/img/connectors/hr/providers/9663298-3739f0acba.jpg)

2. Select **Settings** in the panel that opens.

   ![The Breathe settings panel](/img/connectors/hr/providers/9663298-affaf69162.jpg)

3. Select **API Setup** at the bottom right.

   ![The API Setup section of Breathe settings](/img/connectors/hr/providers/9663298-a362580998.jpg)

## Step 2 — Enable the API

If you haven't enabled it before, select **Enable API** and accept the terms.

![Enabling the Breathe API](/img/connectors/hr/providers/9663298-e81303ff20.jpg)

## Step 3 — Copy the production API key

Take the **production** key, not a test one.

![The production API key on the API Setup page](/img/connectors/hr/providers/9663298-e54ea4e948.jpg)

## Step 4 — Connect in Mesh

Follow [Connect your HR system](../connect-your-hr-system.md), choose Breathe in
the connection window, and paste the production API key.

![The connection window asking for the Breathe API key](/img/connectors/hr/providers/9663298-d34671f6ea.jpg)

## After connecting

The connector appears in your connectors list with **Health: Initializing**
while the first collection runs, then moves to **Good**. Access is
**read-only**: Mesh does not write back to Breathe.

If it doesn't come online, see [Troubleshoot HR
connectors](../troubleshoot-hr-connectors.md).

## Troubleshooting

| What you see | Likely cause | Fix |
|---|---|---|
| The API key is rejected | The API was never enabled on the account | Complete Step 2, then reconnect |
| The connector is healthy but the estate looks wrong | A test key was used instead of the production key | Copy the production key from API Setup |
