Skip to main content
GET
Returns a paginated array of customer objects. Use query parameters to filter, sort, and paginate results.

Query Parameters

limit
integer
default:"20"
Maximum number of customers to return per page. Range: 1-100.Example: 50
offset
integer
default:"0"
Number of records to skip for pagination.Example: 20
order_direction
string
default:"desc"
Sort direction for results. Options: asc, desc.
email
string
Filter customers by email address (exact match).Example: jane.doe@example.com
created_after
string
Filter customers created after this ISO 8601 date.Example: 2024-01-01T00:00:00.000Z

Response

customers
array
Array of customer objects.
total_count
integer
Total number of customers matching the query.
has_more
boolean
Whether there are more results beyond the current page.