List clients

get

http://api-gateway-eu.phorest.com/third-party-api-server/api/business/{businessId}/client

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, deleted and linked clients

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

businessId

string

required

Query Params

string

client email address to filter by

phone

string

client mobile number to filter by

updatedAfter

string

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

updatedBefore

string

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

firstName

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

lastName

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

externalId

string

client externalId to filter by

includeArchived

boolean

include archived clients in the list

includeDeleted

boolean

include deleted clients in the list

includeLinkedClients

boolean

when true and combined with a phone filter, also returns clients linked to the matched clients

size

integer

Defaults to 20

number of client records to return, max is 100

page

integer

Defaults to 0

page number, default is 0 and is optional

Responses

200Clients listed

400Bad Request

404Business with the specified id doesn't exist

429Request rate limit exceeded. Current limit set to 100 rps.

500Internal Server Error