Skip to main content

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.

You finish with two values:

ValueWhere it comes from
SubdomainThe first label of your Freshteam URL
API keyYour profile menu
Third-party product

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

Entering the subdomain in the connection window

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

  2. Copy the key.

    The API key ready to copy

Step 3 — Connect in Mesh

Follow Connect your HR system, choose Freshteam in the connection window, and paste the key.

The connection window asking for the Freshteam 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 Freshteam.

If it doesn't come online, see Troubleshoot HR connectors.

Troubleshooting

What you seeLikely causeFix
Authentication failsThe full host was entered instead of the subdomainEnter only the part before .freshteam.com
The API Key item is missingThe account lacks the rights to view itAsk a Freshteam administrator to retrieve the key