List clients

Get a list of clients for the specified business id. List can be filtered by email, phone, DateTime of update, first and last name, external id and possibility to include archived and deleted clients

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string

client email address to filter by

string

client mobile number to filter by

string

updatedAfter date to filter clients updated after a set date. yyyy-MM-dd'T'HH:mm:ss.SSZ

string

updatedBefore date to filter clients updated before a set date. yyyy-MM-dd'T'HH:mm:ss.SSZ

string

client first name to filter by. To search by exact match use John. To query by matching first letters use ~Jo% which will find both John and Joe

string

client last name to filter by. To search by exact match use Doe. To query by matching first letters use ~Do% which will find both Doe and Doran

string

client externalId to filter by

boolean

include archived clients in the list

boolean

include deleted clients in the list

integer
Defaults to 20

number of client records to return, max is 100

integer
Defaults to 0

page number, default is 0 and is optional

Responses

Language
Credentials
:
URL