List customers

Returns a list of all customers matching the given query parameters who have ever authorized this client to take an action on their account.

This endpoint is rate limited to 50 QPS.

Scopes: CUSTOMERS_READ

Headers

AcceptstringRequired
X-RegionstringRequired
X-SignaturestringRequired
User-AgentstringRequired

Query parameters

cursorstringOptional
A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.
limitintegerOptional>=1<=100Defaults to 50
Maximum number of customers to return.
cashtagstringOptional
Filters results to only include customers with a matching Cashtag.

Response

OK
customerslist of objects
List of customers matching the given query parameters.
cursorstring or null
The pagination cursor to be used in a subsequent request. If empty, this is the final response.

Errors