---
title: "Retrieve a list of Clients"
method: GET
path: "/v2/clients"
tags: ["Clients"]
---

# Retrieve a list of Clients

`GET /v2/clients`

Returns a paginated list of clients. Supports full-text search, tag filtering, due-balance filtering, sorting, and date-range filtering. Results are sourced from Elasticsearch and include basic contact and address information.

## Query parameters

- `pageSize` number
- `page` number
- `searchQuery` string
- `isDue` 'PastDue' | 'Due'
- `tags` string
- `field` 'serialId' | 'firstName' | 'fullName' | 'clientCompany' | 'primaryPhone'
- `order` 'ASC' | 'DESC'
- `dateProperty` 'created'
- `dateOperator` 'prev' | 'next' | 'between'
- `date` string

## Headers

- `Authorization` string, required

## Response `200`

Paginated list of clients.

- ResponseClientsV2Dto
  - `pageSize` number — The maximum number of items returned per page.
  - `page` number — The current page number.
  - `totalResults` number — The total number of results.
  - `hasMore` boolean — Whether there are more results.
  - `data` ResponseAllClientV2Dto[] — A list of the clients.
    - `id` string — The ID of the client (prefix `CL-`).
    - `serialId` number — The serial ID of the client.
    - `firstName` string — The first name of the client.
    - `lastName` string — The last name of the client.
    - `fullName` string — The full name of the client.
    - `companyName` string — The company name of the client.
    - `email` string — The email address of the client.
    - `primaryExt` string — The primary phone extension of the client.
    - `primaryPhone` string — The primary phone of the client.
    - `secondaryExt` string — The secondary phone extension of the client.
    - `secondaryPhone` string — The secondary phone of the client.
    - `country` string — The country of the client.
    - `state` string — The state of the client.
    - `city` string — The city of the client.
    - `zipcode` string — The zipcode of the client.
    - `unit` string — The unit of the client.
    - `address` string — The address of the client.
    - `fullAddress` string — The full address of the client.
    - `clientContacts` ResponseAllClientContactV2Dto[] — The contacts of the client.
      - `firstName` string — The first name of the contact.
      - `lastName` string — The last name of the contact.
      - `fullName` string — The full name of the contact.
      - `email` string — The email address of the contact.
      - `primaryPhone` string — The primary phone number of the contact.
      - `secondaryPhone` string — The secondary phone number of the contact.
      - `country` string — The country of the contact.
      - `state` string — The state of the contact.
      - `city` string — The city of the contact.
      - `zipcode` string — The zip code of the contact.
      - `address` string — The address of the contact.
      - `role` string — The job title or role of the contact.
      - `note` string — A free-text note about the contact.
    - `created` string, date-time — The creation date of the client.

## Other responses

- `400` — Invalid query parameters (e.g. unresolvable tag ID, malformed date range).
- `401` — Missing or invalid authentication token.
- `404` — One or more of the provided tag IDs was not found.

---

[API](https://skmtc.net/workiz/apis/developer-api.md) · [All operations](https://skmtc.net/workiz/apis/developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/workiz/developer-api/revisions/14666f4db0f8/schema)