List employee custom fields
GET
The organization's custom fields for employees, active and archived, ordered by position. Each of its employees carries their values in customFields, keyed by field id.
Without the key scope custom-fields:read-restricted, fields only managers or admins see are left out, names included.
Requires the key scope employees:read.
apiKeyheader
AuthorizationBearer <token>An organization API key (starts with z8_org).
limit?integerRows per page, 1 to 200.
Range
1 <= value <= 200Default
50cursor?stringThe nextCursor of the previous page. Omit it for the first page.
Length
1 <= length <= 1024status?stringOnly fields with this status. Both by default.
Value in
"active""archived"OK
application/json- response
data*array<>nextCursor*|Pass as cursor to read the next page; null on the last page.
curl -X GET 'https://ui.z8-time.app/api/v1/employees/custom-fields'Example Response
{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "type": "text", "tracked": true, "required": true, "visibility": "admin", "archived": true, "position": -9007199254740991, "integerOnly": true, "min": "string", "max": "string", "options": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "label": "string", "archived": true } ] } ], "nextCursor": "string"}