> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/pro/operations/hr-sync.md).

# HR sync

HR sync from the provider's perspective: check the status of all customers' HR synchronizations, understand columns and statuses, and know where the integration is set up.

**Path:** "Operations" → "HR sync"

With **HR sync**, your customers automatically transfer their employee data from their HR system to equipme. New employees, departures and changes arrive without manual maintenance. This is the foundation for automated onboarding and offboarding.

In Pro, you can see at a glance which customers have an HR synchronization running and whether it works: "Here you can view your customers' HR synchronizations and check their status. The data is synchronized every 3 hours by default."

## The overview

| Column                   | Content                                            |
| ------------------------ | -------------------------------------------------- |
| "Customer"               | The customer the integration belongs to            |
| "Integration"            | The customer's connected HR system                 |
| "Status"                 | State of the integration (see below)               |
| "Created"                | When the integration was set up                    |
| "Last synchronization"   | Time of the last sync                              |
| "Synchronized employees" | Number of employees transferred from the HR system |

If there is no integration yet, it shows "No integration has been set up yet."

### Status

| Status          | Meaning                                 | What to do                                   |
| --------------- | --------------------------------------- | -------------------------------------------- |
| "Active"        | The integration synchronizes regularly. | Nothing                                      |
| "Synchronizing" | A sync is currently running.            | Wait                                         |
| "Inactive"      | The integration is set up but paused.   | Activate it in the customer portal           |
| "Invalid"       | Credentials are missing or incorrect.   | Renew the credentials in the customer portal |

{% hint style="warning" %}
When renewing the credentials, the same HR system tenant must be connected as before. If a different tenant is to be connected, the integration is deleted and created again.
{% endhint %}

## Setting up HR sync for a customer

The page in Pro is an overview only. The integration is set up and managed in the respective customer's customer portal:

1. In the [customer details](/pro/customers/customer-details.md), under "Premium features (license required)", enable the "Enable HR sync" option.
2. Switch to the customer's customer portal, add the HR integration there in the integration settings, define filters and settings, and activate it.

Exactly one HR integration is possible per customer. The steps in the customer portal (add integration, filters, field mapping, activate, synchronize, delete) are described in the customer guide under "HR sync".

## Permission

Only users with the "Administrator" role can see this page.

## Frequently asked questions

**How often is the data synchronized?**

Every 3 hours by default. You can start an immediate sync in the customer portal.

**A customer reports missing employees. Where do I start?**

Check "Status" and "Last synchronization" here. If the integration is "Invalid" or the last synchronization was a long time ago, the credentials must be renewed in the customer portal. If it is "Active", check the integration's filters in the customer portal.

**Can I set up HR sync directly in Pro?**

No. Pro only shows the status. Setting up, changing and deleting is done in the customer's customer portal.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://hub.equipme.io/pro/operations/hr-sync.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.