List customers

Returns customers available to the credential-bound company. Results use cursor pagination and support the documented filters, sorting, includes, and sparse fields. Requires the customers:read OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Allowed:
string
length ≤ 191

The whole phrase, as typed, matched as one piece of the name (first and last name together too), account or customer number, VAT ID (also without its spaces, dots and dashes), phone, email or website, as the contact picker searches but never a value the row does not return (the legal name, the IBAN); % and _ match themselves.

integer
1 to 100
Defaults to 25

Number of resources per cursor page (1-100).

string

Opaque cursor returned by the preceding collection response.

string

Comma-separated allowlisted sort fields; prefix descending fields with a minus sign.

string

Comma-separated allowlisted relationships.

string

Comma-separated allowlisted sparse response fields. The id field is always retained.

string

Allowlisted exact or bounded collection filter.

string

Allowlisted exact or bounded collection filter.

string

Allowlisted exact or bounded collection filter.

string

Allowlisted exact or bounded collection filter.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*