List employees
The organization's employees, including departed ones. Contract, salary, address and birthday are never returned.
Each employee carries its custom field values as of asOf in customFields, keyed by field id; GET /api/v1/employees/custom-fields describes the fields.
Requires the key scope employees:read.
apiKeyAuthorizationBearer <token>An organization API key (starts with z8_org).
limit?integerRows per page, 1 to 200.
1 <= value <= 20050cursor?stringThe nextCursor of the previous page. Omit it for the first page.
1 <= length <= 1024status?stringOnly employees with this status. Both by default.
"active""departed"asOf?stringThe date custom field values are read as of, YYYY-MM-DD. Today in the organization's timezone by default. A tracked field returns the value valid on this date; an untracked field its only value.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$dateOK
application/json- response
data*array<>nextCursor*|Pass as cursor to read the next page; null on the last page.
asOf*stringThe date the customFields values were read as of.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$datecurl -X GET 'https://ui.z8-time.app/api/v1/employees'{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firstName": "string", "lastName": "string", "workEmail": "string", "employeeNumber": "string", "teamIds": [ "3320e832-c6a5-4b64-ade9-357b3004570a" ], "managerId": "b2c2c359-55f3-4680-a660-901475c7a693", "status": "active", "startDate": "2019-08-24", "departureDate": "2019-08-24", "customFields": { "property1": "string", "property2": "string" } } ], "nextCursor": "string", "asOf": "2019-08-24"}