# Freshteam setup

Freshteam connects through the **unified HRIS connector**. This page covers the
Freshteam-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 two values:

| Value | Where it comes from |
|---|---|
| **Subdomain** | The first label of your Freshteam URL |
| **API key** | Your profile menu |

> **warning**

These steps reflect Axiad's current understanding of Freshteam's configuration.
Because Freshteam 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 — Find your subdomain

Your subdomain is the part between `https://` and `.freshteam.com`.

![The Freshteam address bar showing the subdomain](/img/connectors/hr/providers/5446118-6b87712980.jpg)

![Entering the subdomain in the connection window](/img/connectors/hr/providers/5446118-ba267f1b1a.jpg)

## Step 2 — Find your API key

1. Sign in and hover over your profile image at the top right of any page, then
   select **API Key**.

   ![The Freshteam profile menu with API Key](/img/connectors/hr/providers/5446118-889e8578b4.jpg)

2. Copy the key.

   ![The API key ready to copy](/img/connectors/hr/providers/5446118-6c5dd3ccfc.jpg)

## Step 3 — Connect in Mesh

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

![The connection window asking for the Freshteam API key](/img/connectors/hr/providers/5446118-b57fbf0162.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 Freshteam.

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

## Troubleshooting

| What you see | Likely cause | Fix |
|---|---|---|
| Authentication fails | The full host was entered instead of the subdomain | Enter only the part before `.freshteam.com` |
| The API Key item is missing | The account lacks the rights to view it | Ask a Freshteam administrator to retrieve the key |