Skip to content
Quenza
MCPNew: use this help center in Claude, ChatGPT or CursorConnect →

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.

GEThttps://developers.quenza.com/v1/clients

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

  • offsetinteger

    How many records to skip. Defaults to 0.

  • limitinteger

    How 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:

  • idstring

    The client’s ID. Use it in the URL of the other client endpoints and to add the client to a group.

  • emailstring

    Email address, unique in your workspace.

  • first_namestring

    First name.

  • last_namestring

    Last name.

  • statusstring

    pending until the client accepts the invitation, then active. archived after you archive the client.

    One of active, pending, archived.

  • is_guestboolean

    Whether the client is a guest without a login. Clients created through the API are never guests.

  • timezonestring

    Time zone as an IANA name, such as Europe/Amsterdam.

  • phonestringor null

    Phone number as free text, such as +31 6 1234 5678, or null.

  • genderstringor null

    Gender, or null.

    One of male, female, other.

  • gender_identitystringor null

    How the client describes their gender, as free text, or null.

  • birthdatestringor null

    Date of birth as YYYY-MM-DD, or null.

    Format YYYY-MM-DD.

  • invited_atstringor null

    When the invitation email was sent.

    ISO 8601 date and time in UTC.

  • invitation_accepted_atstringor null

    When the invitation was accepted, or null while it is pending.

    ISO 8601 date and time in UTC.

  • archived_atstringor null

    When it was archived, or null.

    ISO 8601 date and time in UTC.

  • created_atstring

    When it was created.

    ISO 8601 date and time in UTC.

  • updated_atstring

    When it was last changed.

    ISO 8601 date and time in UTC.

Status codes

Enlarged screenshot from this article