Clients
Get a client
Read one client's details from the Quenza API by their ID, such as their email, status, time zone and when they accepted their invitation.
Returns the client with this ID, also when they are pending or archived. An ID that belongs to no client in your workspace answers with 404.
To find a client by email, read the list of clients; the API has no search.
Path parameters
clientstringRequiredThe client’s ID, such as
8GJ4D9KQ.
Response
200 with the client in data:
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.