Retrieve a customer list

Get a paginated list of your customer profiles.

Filtering	Pagination
Filter the customers that you want to retrieve, for example, only retrieve customers created within a specific date range. Parameters used for filtering: from to	View customers without loading all of them at once, for example, return a specified number of customers per page. Parameters used for pagination: limit page_token

To paginate through all results:

1. Make an initial request with the desired limit and any filter parameters.
2. If more results are available, the response includes a next_page_token.
3. Pass next_page_token as page_token in your next request, keeping all other parameters unchanged.
4. Repeat until next_page_token is no longer present in the response.

Request​

Query parameters

Query parameters

Possible values: >= 1 and <= 500

Default value: 100

Maximum number of records to return. Used for pagination.

Token for retrieving the next page of results. Used for pagination.

To paginate through results:

1. Make an initial request with the desired limit.
2. The response will include a next_page_token if more results are available.
3. Use that token in the page_token parameter of your next request.
4. Repeat until next_page_token is not present.

Note

When using page_token, you must include all query parameters from the initial request (such as from, to, or other filter parameters) to maintain consistent filtering across pages.

Filter records created from this date/time. Used for filtering.

Filter records created until this date/time. Used for filtering.

Header parameters

Header parameters

Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"

This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.

It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.

Info

For more information, see: Authentication

Possible values: [2024-09-01, 2025-10-16, 2025-12-04, 2026-03-12, 2026-04-20]
Example: "2026-04-20"

The version of the Merchant API, specified in YYYY-MM-DD format.

This endpoint is available from version 2024-09-01. If a version earlier than 2024-09-01 is provided, the endpoint returns a 404 response.

If not specified, you will receive an error.

Info

For more information about API versioning, see: API versions.

Response​

OK

Response body

Body object

Token for retrieving the next page of results. Use this token as the value of the page_token query parameter in your next request to retrieve the next page.

If not present, there are no more results to retrieve.

List of customers.

Unique identifier for the customer.

The full name of the customer.

The email address of the customer.

The phone number of the customer in E.164 format.

The date and time the customer was created.

The date and time the customer was last updated.