List Customers

scope customers:read

Retrieve a list of Customers for the specified Account (Merchant). This endpoint allows you to view all customers associated with your account.

Info

The response includes pagination information to help you navigate through large customer lists.

You can filter customers by various criteria and sort the results as needed.

Tip: For large customer lists, consider using pagination parameters to optimize performance and reduce response times.

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

The unique identifier (AVID) of the Account.

Query Params
integer
≤ 100
Defaults to 50

Maximum number of customers to return per page.

integer
Defaults to 0

Number of customers to skip for pagination.

string
enum

Filter customers by status.

Allowed:
Responses

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