Skip to main content
GET
Deprecated. This endpoint is no longer part of the public API. Use List individual clients under Individual Clients instead.
Retrieves a list of all clients for the company, with optional filtering by communication preferences. Requires an API key with access level 1 or higher.

Query parameters

otp
boolean
Filter by OTP preference.
sms
boolean
Filter by SMS preference.
whatsapp
boolean
Filter by WhatsApp preference.
telegram
boolean
Filter by Telegram preference.

Response

Returns an array of client objects. See Get client by ID for the full field list.