List customers with filtering and pagination

Retrieve customers with rich filtering, sorting, and pagination. Supports API versioning for enhanced features.

API Version Header:

  • Add header apiversion: 20230501 for enhanced filtering, ordering, and expand capabilities.
  • Without header: uses default API version with basic sorting.

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). Available with apiversion: 20230501.
  • sort_key & sort_type: alternative sorting (legacy). Available without apiversion header.

Expand:

  • expand: comma-separated list of related resources to include (e.g., contacts). Available with apiversion: 20230501.
Language
Credentials
Click Try It! to start a request and see the response here!