> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fluidehr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Description

> Employee records, leave, performance, and HR operations for the Fluide Suite.

The **HR API** is the canonical source for employee data in the Fluide Suite. Payroll, document generation, and other products consume HR records.

## Base path

`/api/v1/hr`

## Authorization

All endpoints — including `GET /api/v1/hr/health` — require **three** headers:

* `Authorization: Bearer <accessToken>`
* `X-Fluide-Api-Key: fl_dev_...`
* `X-Fluide-Client-Id: fluide-developer`

In the API playground, click **Authorize** and fill all three fields before **Send**. See [Authorization](/getting-started/authorization).

## Operations and monitoring

| Endpoint                 | Purpose                        |
| ------------------------ | ------------------------------ |
| `GET /api/v1/hr/health`  | Liveness and dependency health |
| `GET /api/v1/hr/metrics` | Prometheus scrape target       |

Use health endpoints in deployment pipelines. Point your metrics collector at the Prometheus path for request rates and latency.

## Typical integration flow

1. Create or sync employees via `POST /api/v1/hr/employees`
2. Configure leave, contracts, or performance modules as needed
3. Trigger payroll runs that reference HR employee IDs

<CardGroup cols={2}>
  <Card title="HR product guide" icon="users" href="/hr/overview">
    Modules, permissions, and payroll handoff.
  </Card>

  <Card title="How-to guides" icon="book-open" href="/guides/hr/add-employee">
    Add employees, contracts, leave, and attendance.
  </Card>

  <Card title="First request" icon="rocket" href="/getting-started/first-request">
    End-to-end token exchange and API call.
  </Card>
</CardGroup>