Skip to main content

HR quickstart

Use this guide to confirm your integration can reach Fluide HR and create an employee. You need API credentials from the Connect dashboard — see Authorization.

Prerequisites

VariableExample
FLUIDE_BASE_URLhttps://sandbox.fluidehr.com
FLUIDE_API_KEYfl_dev_...
FLUIDE_ACCESS_TOKENJWT from token exchange

1. Verify connectivity

curl -X GET "$FLUIDE_BASE_URL/api/v1/hr/health" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \
  -H "X-Fluide-Client-Id: fluide-developer"
A 200 response means your credentials and base URL are correct.

2. Create an employee

Employee records in HR are the source of truth for payroll and other suite products.
curl -X POST "$FLUIDE_BASE_URL/api/v1/hr/employees" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \
  -H "X-Fluide-Client-Id: fluide-developer" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Ada",
    "lastName": "Lovelace",
    "email": "ada@example.com",
    "employeeCode": "EMP-001"
  }'
Field requirements vary by endpoint. Open Create HR employee record in HR API reference for the full schema and required properties.

Next steps

HR overview

Modules, leave, contracts, and how HR fits your integration.

HR API reference

Browse and try all HR endpoints.

Payroll quickstart

Run payroll after employees exist in HR.

API playground

Authorize requests directly in the docs.