Get a list of Customers

Retrieves a list of Customers filtered by the given parameters. Filter parameters are not case sensitive, but will only return exact matches. Multiple filter parameters can be provided at once, but a result will not be returned unless there are exact matches for all submitted parameters.

As an example - submitting first_name=Olive&last_name=Oyl would match exactly "Olive Oyl" but NOT "Olive Boyl" or "Oliver Oyl".

The list endpoint will not include sensitive Customer data such as address or DOB. This can only be retrieved by viewing a specific Customer record.

By default we do not display Customers in the initiated status, as Customers in this status have not completed onboarding. To cause Customers with this status to be included in the list you must provide the include_initiated=true parameter.

Language