Developer Docs

Get paginated list of customers

Returns a paginated list of customers belonging to the authenticated merchant. Supports filtering by search term (matches email, first name, or last name), whether the customer has an active payment method, billing country, and whether they are purchasing as a business. Use the page and limit query parameters to control pagination.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Search term to filter customers by email, first name, or last name

boolean

Filter customers by whether they have an active payment method

string

Filter customers by billing country

boolean

Filter customers by whether they are purchasing as a business

number

The page number

number

The number of items per page

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json