Get Clients

Overview

Retrieves a paginated list of clients for the business. Supports searching by various attributes and filtering by update timestamp.

Authentication

Available for Staff, App, and Directory Tokens.

Directory tokens require the X-On-Behalf-Of header with the target business UID. The endpoint is business-scoped, and a directory token carries no business context on its own — without this header no business can be resolved and the request cannot return clients. The target business must belong to the directory, otherwise the request is rejected as unauthorized.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Search Term

string

Search By - email/uid/phone/updated_at

string

Specify the updated_at filter range, available operators for updated_at: gte, lte. example: updated_at[gte]=2019-01-01

integer

Page number of results. Default: 1

integer

How many items to return per page. Default: 25. Max: 100

Headers
string

Business UID to act on behalf of. Required for Directory tokens.

Responses

422

Unprocessable Entity - Invalid request parameters

429

Too Many Requests - Rate limit exceeded for this business

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json