Skip to main content
GET
List customers for a business

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

business_id
string<biz_string>
required

Query Parameters

search
string | null

Case-insensitive substring match against the customer's name. (value)

Maximum string length: 255
is_disabled
boolean
default:false

If true, only disabled customers are returned. Defaults to false (only active).

page_token
string | null

The page token to for the next or previous page

page_size
integer
default:100
Required range: 1 <= x <= 100

Response

Successful Response

data
Customer · object[]
required

List of customers

pagination
PaginationResponse · object
required

Pagination information