List customers

Retrieve a list of customers that belong to the merchant.

Query Params
string

Customer's name. Max 100 characters.

string

Customer's first name. Max 50 characters.

string

Customer's last name. Max 50 characters.

string

The company name if the company is registered as a customer.

string

The reference code of the customer. A unique identifier from a third-party software integration.

string

Auto-generated unique customer number. This unique identifier is customer facing and used to uniquely identify a customer across merchants.

string

The date the customer's record was created.

string

Apply the expression to sort the customer's list based on the preferred argument. For e.g., enter lastname,ASC to sort the customer list in alphabetical order based on the lastname parameter.

int32
Defaults to 100

To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, limit = 10 shows results 1-10. The default returned result would be 100.

int32

An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.

Headers
string
required

Merchant ID

Response

Language
Response
Choose an example:
application/json