List All Customers

page * Fetch the results from a specific page. It defaults to 1.

per_page * The number of results to fetch per page. The maximum is 50 and if it defaults to 10.

from date-format Start date to use for filtering (the date the customer was created).

to date-format End date used for filtering (the date the customer was created).

sort_by An optional identifier used for sorting results. Available options are name, email and country.

filter Optional text used for filtering results.

affiliate_program_partner_id If provided, it will return the customers that were referred by the partner.

affiliate_program_id If provided, it will return the customers that were referred by affiliates who joined this affiliate program.

teammate_id If provided, it will return the customers that are assigned to the teammate.

product_id If provided, it will return the customers who bought this product.

countries (Country codes) (example ?countries=de,ro) A list of country codes to use for filtering.

order Determines in which order the results are returned. The available options are asc (ascending) and desc (descending). The default value is desc.