# PeopleHR setup

PeopleHR connects through the **unified HRIS connector**. This page covers the
PeopleHR-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: an **API key**.

## Before you start

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

> **warning**

These steps reflect Axiad's current understanding of PeopleHR's configuration.
Because PeopleHR 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 key management

1. Select **Access** at the top left and choose **HR Admin**.
2. Go to **Settings** in the left sidebar, select **API**, and select the **+**
   icon.

   ![The PeopleHR settings sidebar with API selected](/img/connectors/hr/providers/6634325-49161d5de5.jpg)

   ![The API section with the add-key action](/img/connectors/hr/providers/6634325-71700e87d5.jpg)

## Step 2 — Create the key

1. Name the key — something identifying the Axiad Mesh connection.

   ![The API Key Management screen with a name entered](/img/connectors/hr/providers/6634325-16c06e2095.jpg)

2. Under application actions, select the data the key may read. **Employee** is
   what identity correlation depends on; Salary, Absence, and Holiday are
   optional.

   ![Selecting the employee application actions for the key](/img/connectors/hr/providers/6634325-9471d922e8.jpg)

3. Select **Save**, then copy the key.

   :::danger Store the key now

   Copy it somewhere secure before leaving the screen.

   :::

   ![The saved key ready to copy](/img/connectors/hr/providers/6634325-f22a519812.jpg)

## Step 3 — Connect in Mesh

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

## 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 PeopleHR.

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

## Troubleshooting

| What you see | Likely cause | Fix |
|---|---|---|
| The connector authorizes but collects no people | The key has no **Employee** application actions | Create a key with them selected |
| You no longer have the key | PeopleHR shows it once at creation | Create a new key and reconnect |