Skip to main content
GET
List customers

Filtering

Filters are written as field=value, or field:operator=value where the field supports more than equality. A repeated parameter and a comma-separated one mean the same thing, so type:in=individual&type:in=business and type:in=individual,business are equivalent.
Every rejected parameter is named in the errors array, so three bad filters are reported at once rather than one request at a time.

Error codes

Authorizations

Authorization
string
header
required

A secret API key, sent as Authorization: Bearer sk_test_… in sandbox or Bearer sk_live_… in live.

Query Parameters

page
integer
default:1

One-based page number.

Required range: x >= 1
pageSize
integer
default:25

Records per page. A larger value is rejected rather than capped, so your paging arithmetic stays correct.

Required range: 1 <= x <= 100

Case-insensitive term matched against name, firstName, lastName, email, and externalReference. Maximum 100 characters.

Maximum string length: 100
sort
string

Up to three comma-separated keys from name, firstName, lastName, tier, and createdAt. Prefix a key with - for descending order.

name
string

Exact match on the stored name.

firstName
string

Exact match. Individual customers only.

lastName
string

Exact match. Individual customers only.

email
string<email>

Exact match on the stored, lowercased address.

externalReference
string

Exact match on your own reference.

type
enum<string>

Filter by customer type.

Available options:
individual,
business
type:in
string

Comma-separated customer types.

jurisdiction
string

ISO 3166-1 alpha-2 country of the customer relationship.

Required string length: 2
jurisdiction:in
string

Comma-separated country codes. At most 50.

tier
integer

Exact tier. Customers are created at tier 1.

Required range: 1 <= x <= 3
tier:gte
integer

Tier at or above this value.

Required range: 1 <= x <= 3
tier:lte
integer

Tier at or below this value.

Required range: 1 <= x <= 3
createdAt:gte
string<date-time>

Created at or after this ISO 8601 timestamp.

createdAt:lte
string<date-time>

Created at or before this ISO 8601 timestamp.

Response

Successful response.

items
object[]
required
pagination
object
required