Retrieve Customer List

Query Params

start_date

int64

The start date for the search, specified as a Unix timestamp. This applies to the customer creation date.

end_date

int64

The end date for the search, specified as a Unix timestamp. This applies to the customer creation date.

limit

int32

Defaults to 10

The number of records to retrieve. If not provided it defaults to 10.

page

int32

Defaults to 1

The page to retrieve based on the limit parameter provided. If not provided it defaults to 1.

string

Search by name and email address.

order_by

array of strings

Defaults to created:desc

The parameters and the directions to sort by. Parameters allowed: created and email. E.g. created:desc

order_by

expand

array of strings

Parameters to expand in the response. Allowed parameters: invoicesettings.defaultpaymentmethod.

expand

Headers

onBehalfOf

string

Specifies the account for which the Customer list retrieval is intended. This is used for scenarios where one partner processes payments on behalf of another partner, such as in PayFac or related partner relationships.

200200

400400