Retrieve a customer list

Get a list of all your customers.

Request

Query Parameters
Query Parameters

Possible values: >= 1 and <= 100

Default value: 100

The maximum number of customers returned per page. Used for pagination.

A zero-based page index for the paginated results, used in conjunction with limit.

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

Response

OK

Response body
Body array of objects

Permanent customer ID used to retrieve, update, and delete a customer.

The full name of the customer.

The name of the customer's business.

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

The date and time the customer was created.

The data and time the customer was last updated.

The email address of the customer.

The birth date of the customer.

Was this page helpful?