Clients
List clients
Get all clients of your workspace from the Quenza API, page by page, including clients who are pending or archived, sorted by name.
Returns every client in the workspace: active clients, clients who have not accepted their invitation yet (pending) and archived clients. The list is sorted by last name, then first name. Your own demo client is not included.
Use status to tell them apart, and pagination to read more than one page.
Query parameters
offsetintegerHow many records to skip. Defaults to
0.limitintegerHow many records to return, from 1 to 100. Defaults to
20.
Response
200 with a page of clients: data holds the clients, meta and links tell you where you are (see Pagination). Each client in data has these fields:
idstringThe client’s ID. Use it in the URL of the other client endpoints and to add the client to a group.
emailstringEmail address, unique in your workspace.
first_namestringFirst name.
last_namestringLast name.
statusstringpendinguntil the client accepts the invitation, thenactive.archivedafter you archive the client.One of
active,pending,archived.is_guestbooleanWhether the client is a guest without a login. Clients created through the API are never guests.
timezonestringTime zone as an IANA name, such as
Europe/Amsterdam.phonestringor nullPhone number as free text, such as
+31 6 1234 5678, ornull.genderstringor nullGender, or
null.One of
male,female,other.gender_identitystringor nullHow the client describes their gender, as free text, or
null.birthdatestringor nullDate of birth as
YYYY-MM-DD, ornull.Format
YYYY-MM-DD.invited_atstringor nullWhen the invitation email was sent.
ISO 8601 date and time in UTC.
invitation_accepted_atstringor nullWhen the invitation was accepted, or
nullwhile it is pending.ISO 8601 date and time in UTC.
archived_atstringor nullWhen it was archived, or
null.ISO 8601 date and time in UTC.
created_atstringWhen it was created.
ISO 8601 date and time in UTC.
updated_atstringWhen it was last changed.
ISO 8601 date and time in UTC.
Status codes
Was this article helpful?
Thanks for letting us know.
Thank you. We read every answer and use it to improve this article.