Skip to main content
GET
/
api
/
v1
/
hr
/
employees
cURL
curl -sS -X GET "$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"
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

Authorizations

​
Authorization
string
header
required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

​
X-Fluide-Api-Key
string
header
default:fl_dev_your_key
required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

​
X-Fluide-Client-Id
string
header
default:fluide-developer
required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Query Parameters

​
q
string

Free-text search (endpoint-specific)

Maximum string length: 200
​
page
number
default:1
Required range: x >= 1
​
limit
number
default:20
Required range: 1 <= x <= 100
​
employment
enum<string>

Directory scope: active = ACTIVE+ON_LEAVE (default), workforce = ACTIVE+ON_LEAVE+PENDING, all, terminated, pending, inactive

Available options:
active,
workforce,
all,
terminated,
pending,
inactive

Response

List employees

​
success
boolean
required

Whether the request succeeded

Example:

true

​
message
string
required

Human-readable outcome message (localized when i18n is configured)

Example:

"Operation completed successfully"

​
data
object

Endpoint-specific payload