# 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.

Source: https://quenza.com/help/api/clients/list-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](https://quenza.com/help/api/pagination/) to read more than one page.

## Request

`GET https://developers.quenza.com/v1/clients`

### Query parameters

- `offset` (integer): How many records to skip. Defaults to `0`.
- `limit` (integer): How many records to return, from 1 to 100. Defaults to `20`.

### Example

```bash
curl "https://developers.quenza.com/v1/clients?limit=2" \
  -H "Authorization: Bearer $QUENZA_API_TOKEN" \
  -H "Accept: application/json"
```

## Response

200 OK.

### Fields of each record in data

- `id` (string): The client’s ID. Use it in the URL of the other client endpoints and to add the client to a group.
- `email` (string): Email address, unique in your workspace.
- `first_name` (string): First name.
- `last_name` (string): Last name.
- `status` (string): `pending` until the client accepts the invitation, then `active`. `archived` after you archive the client. One of `active`, `pending`, `archived`
- `is_guest` (boolean): Whether the client is a guest without a login. Clients created through the API are never guests.
- `timezone` (string): Time zone as an IANA name, such as `Europe/Amsterdam`.
- `phone` (string, or null): Phone number as free text, such as `+31 6 1234 5678`, or `null`.
- `gender` (string, or null): Gender, or `null`. One of `male`, `female`, `other`
- `gender_identity` (string, or null): How the client describes their gender, as free text, or `null`.
- `birthdate` (string, or null): Date of birth as `YYYY-MM-DD`, or `null`. Format `YYYY-MM-DD`
- `invited_at` (string, or null): When the invitation email was sent. ISO 8601 date and time in UTC
- `invitation_accepted_at` (string, or null): When the invitation was accepted, or `null` while it is pending. ISO 8601 date and time in UTC
- `archived_at` (string, or null): When it was archived, or `null`. ISO 8601 date and time in UTC
- `created_at` (string): When it was created. ISO 8601 date and time in UTC
- `updated_at` (string): When it was last changed. ISO 8601 date and time in UTC

```json
{
  "data": [
    {
      "id": "8GJ4D9KQ",
      "email": "emma.clarke@example.com",
      "first_name": "Emma",
      "last_name": "Clarke",
      "status": "active",
      "is_guest": false,
      "timezone": "Europe/Amsterdam",
      "phone": "+31 6 1234 5678",
      "gender": "female",
      "gender_identity": null,
      "birthdate": "1991-04-12",
      "invited_at": "2026-09-02T08:15:00.000000Z",
      "invitation_accepted_at": "2026-09-02T19:40:12.000000Z",
      "archived_at": null,
      "created_at": "2026-09-02T08:15:00.000000Z",
      "updated_at": "2026-10-14T10:02:31.000000Z"
    },
    {
      "id": "2M7ZP5AT",
      "email": "lucas.meyer@example.com",
      "first_name": "Lucas",
      "last_name": "Meyer",
      "status": "pending",
      "is_guest": false,
      "timezone": "Europe/Amsterdam",
      "phone": null,
      "gender": "male",
      "gender_identity": null,
      "birthdate": null,
      "invited_at": "2026-11-03T09:30:00.000000Z",
      "invitation_accepted_at": null,
      "archived_at": null,
      "created_at": "2026-11-03T09:30:00.000000Z",
      "updated_at": "2026-11-03T09:30:00.000000Z"
    }
  ],
  "meta": {
    "limit": 2,
    "offset": 0,
    "total": 24
  },
  "links": {
    "next": "https://developers.quenza.com/v1/clients?limit=2&offset=2",
    "prev": null
  }
}
```

Status codes: 200 OK, 401 Unauthenticated, 402 Workspace not active, 403 Not on your plan, 406 Not acceptable. See /help/api/errors/.
