List customers with filtering and pagination
Customers
List customers with filtering and pagination
Retrieve customers with rich filtering, sorting, and pagination.
Filter by:
- Customer attributes: customer_name, email, custom_data fields.
- Dates: created_at, updated_at (range filters supported).
- Search: use search parameter for flexible multi-field queries.
Pagination & sorting:
- limit: page size (default varies by configuration).
- cursor: pass ‘next’ or ‘previous’ from response to paginate.
- order: field to sort by with - prefix for descending (e.g., -created_at).
Expand:
- expand: comma-separated list of related resources to include (e.g., contacts).
GET
List customers with filtering and pagination
Authorizations
Query Parameters
The cursor indicating a unique set of results - this should be auto generated and you get it from the next and previous fields of the response
Example:
"V2VsbCBhcmV1IGN1cmlvdxM="
The number of results to return - defaults to 10
Example:
10
Example:
"customer_name=Acme"
Example:
"order=created_at"
Example:
"sort_key=id"
Example:
"sort_key=asc"
Example:
"expand=contacts"
Response
Successfully retrieved customers
The results for the current page
The cursor for the next page of results
Example:
"V2VsbCBhcmV1IGN1cmlvdxM="
The cursor for the previous page of results
Example:
"GmBsbCBhcmV1IGN1cmlvdxM="
The total count of rows