List customers
The organization's customers, active and inactive. Contact details and tax data are never returned.
Each customer carries its custom field values as of asOf in customFields, keyed by field id; GET /api/v1/customers/custom-fields describes the fields.
Requires the key scope customers: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 customers with this status. Both by default.
"active""inactive"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/customers'{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "status": "active", "customFields": { "property1": "string", "property2": "string" } } ], "nextCursor": "string", "asOf": "2019-08-24"}