Skip to main content
GET
List merchant customers

Authorizations

Authorization
string
header
required

Your secret key as a Bearer token. The key prefix selects the environment: sk_test_... (staging) or sk_live_... (production); a key on the wrong host is refused with 403 Unauthorized Access. Each key is limited to 10 requests per minute (429 beyond that) and, on production, to the IP addresses on your dashboard allowlist when one is configured.

Query Parameters

page
integer
default:1

Page number (1-based).

limit
integer
default:10

Items per page.

email
string<email>

Look up the single customer with this email address. Case-insensitive.

phone
string

Look up the single customer with this phone number. Any spelling of the same number matches, so 08012345678 and 2348012345678 both find the same customer and you do not need to send it in the format you created it with. Only the country prefix is interchangeable: a different subscriber number is a different customer.

Response

Paginated customers. When email or phone is sent, a single-row page.