Skip to main content
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.

​
Operations and monitoring

EndpointPurpose
GET /api/v1/hr/healthLiveness and dependency health
GET /api/v1/hr/metricsPrometheus 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

HR product guide

Modules, permissions, and payroll handoff.

First request

End-to-end token exchange and API call.