Sign in
latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Clients

Retrieve a list of 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.

get/v2/clients

Query parameters

pageSizenumber
Example:10

Number of records to return per page.

pagenumber
Example:1

The page index.

searchQuerystring
Example:John Doe

Free-text search string matched against full name, company name, full address, parent full name, custom fields, primary phone, and email address.

isDue'PastDue' | 'Due'

Filter clients by outstanding balance status. Due returns clients with any open balance; PastDue returns clients whose balance is overdue.

tagsstring
Example:TAG-16a94b03317f6e64,TAG-211d1676f4b90c40

Comma-separated list of tag IDs to filter by. Only clients that have all specified tags are returned.

field'serialId' | 'firstName' | 'fullName' | 'clientCompany' | 'primaryPhone'

Field to sort results by. When omitted the default sort is by serialId descending.

order'ASC' | 'DESC'

Sort direction. Defaults to DESC.

dateProperty'created'

The client date field to apply the date filter to. Must be combined with dateOperator and date.

dateOperator'prev' | 'next' | 'between'

Comparison operator for the date filter. Must be combined with dateProperty and date.

datestring

Date value(s) for the filter. Format depends on dateOperator: prev / next accept a single date (YYYY-MM-DD); between accepts two dates separated by _ (YYYY-MM-DD_YYYY-MM-DD).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

Paginated list of clients.

pageSizenumber

The maximum number of items returned per page.

pagenumber

The current page number.

totalResultsnumber

The total number of results.

hasMoreboolean

Whether there are more results.

Example response

{
  "pageSize": 10,
  "page": 1,
  "totalResults": 50,
  "hasMore": true,
  "data": [
    {
      "id": "CL-OvmDp2yvv1yqMwRl",
      "serialId": 1023,
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "John Doe",
      "companyName": "John Doe Inc.",
      "email": "john.doe@example.com",
      "primaryExt": "123",
      "primaryPhone": "1234567890",
      "secondaryExt": "456",
      "secondaryPhone": "1234567890",
      "country": "USA",
      "state": "NY",
      "city": "New York",
      "zipcode": "10001",
      "unit": "100",
      "address": "123 Main St",
      "fullAddress": "123 Main St, New York, NY 10001",
      "clientContacts": [
        {
          "firstName": "John",
          "lastName": "Doe",
          "fullName": "John Doe",
          "email": "john.doe@example.com",
          "primaryPhone": "1234567890",
          "secondaryPhone": "1234567890",
          "country": "USA",
          "state": "NY",
          "city": "New York",
          "zipcode": "10001",
          "address": "123 Main St",
          "role": "Property Manager",
          "note": "Prefers contact by email."
        }
      ],
      "created": "2026-01-01 00:00:00"
    }
  ]
}