API ReferenceClients

List Clients

Retrieve a paginated list of clients. Supports: - Pagination (`page_size`, `page`) - Date filtering (`updated_after`, `updated_before`) - Sorting (`order_by`, default: desc) - Field search (`title`, `address`, `primaryName`, `primaryPhone`, `primaryEmail`) - Full text search (`q`)

Authentication

x-api-keystring
API Key authentication via header

Query parameters

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

updated_afterstringOptionalformat: "date-time"

Filter items updated after this timestamp (ISO 8601)

updated_beforestringOptionalformat: "date-time"

Filter items updated before this timestamp (ISO 8601)

order_byenumOptionalDefaults to asc
Sort order for results
Allowed values:
include_virtual_propertiesbooleanOptionalDefaults to false
Whether to include virtual properties in the response. Defaults to false unless explicitly set to true.
include_contactsbooleanOptionalDefaults to false
Whether to include associated contacts in the response. Defaults to false unless explicitly set to true.
qstringOptional
Full text search query
titlestringOptional
Title search query
addressstringOptional
Address search query
primaryNamestringOptional
Contact name search query
primaryPhonestringOptional
Contact phone search query
primaryEmailstringOptional
Contact email search query

Response

List of clients
addressstring or null

Record location/address

clientTypeenum or null

Type of client (residential or commercial)

Allowed values:
companyIdinteger or null
Company identifier
contactslist of objects or null
createdAtstring or nullformat: "date-time"
Creation timestamp
custommap from strings to any or null
Custom fields
descriptionstring or null
Record description
idinteger or null
Unique identifier
isActiveboolean or null
Whether the record is active
numberinteger or null

Record number (e.g., 1234)

primaryEmailstring or nullformat: "email"
Primary contact email
primaryPhonestring or null
Primary contact phone
titlestring or null

Record title/name

updatedAtstring or nullformat: "date-time"
Last update timestamp

Errors