API reference
List employees
GET
Current and former employees (deleted records are never returned). Requires employees:read.
header
AuthorizationBearer <token>OAuth 2.0 client credentials. Enter the client ID and client secret from Settings, API access; the token lasts one hour.
status?stringExact employment status, e.g. active or terminated.
Match
^[a-z_]{1,30}$updated_since?stringOnly records changed at or after this RFC 3339 time (with an offset), for incremental sync.
Format
date-timelimit?integerRange
1 <= value <= 500Default
100cursor?stringnext_cursor from the previous page, unchanged.
A page of employees.
application/json- response
has_more*booleannext_cursor*string|nulldata*array<>curl -X GET "https://example.com/v1/employees"{ "has_more": true, "next_cursor": "string", "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "first_name": "string", "last_name": "string", "preferred_name": "string", "job_title": "string", "department": "string", "status": "string", "start_date": "2019-08-24", "leaving_date": "2019-08-24", "holiday_calendar": "string", "updated_at": "2019-08-24T14:15:22Z" } ]}