v1
latestOpenAPI 3.0.02026-07-261090122.9 KBCustomers
Retrieve customers list
get/customers
Query parameters
sort_bystring
Allowed values: searchable, email, phone, address_1
sort_dirstring
Allowed values: asc, desc
limitstring
Defaults to 20 items per page, maximum 100 items allowed.
pagestring
Page number. Starts from 1, defaults to 1.
searchstring
Search string.
filterstring
Array of attribute, operator, and value parts.
asnstring
Array or object containing either a team_id index, assigned_members index containing an array of member ids, or both.
sortstring
Array of attribute and order values.
relstring
array consisting of indices with the desired relation to include
calculate_countstring
true or false. If true, in response will be included also total count
Response
Successful response