Skip to main content
GET
List customers linked to a merchant

Authorizations

Authorization
string
header
required

Merchant API key bearer token. Legacy wire prefixes api_key_ and api_ are also accepted.

Path Parameters

merchantId
string
required

Merchant TypeID (mer_...) for customer visibility scope.

Query Parameters

hasPayments
boolean

When true, return only customers with payments for this merchant. When false, return only customers without payments.

Example:

true

q
string

Case-insensitive search across customer name and email.

Example:

"amina"

cursor
string

Opaque cursor returned from a previous page response.

Example:

"eyJ2IjoxLCJkYXRhIjp7ImZpcnN0U2VlbkF0Ijoi...In19"

limit
number

Max number of customers to return (default service limit).

Example:

25

Response

200 - application/json
items
object[]
required
page
object
required