Returns customers of the app to which you have access

By passing in the appropriate query, you can receive filtered and paginated list of customers

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string | null
required

App Name Id

Query Params
string | null

Pass phone number or customer name

StoreId
array of int32s | null

Query store/s

StoreId
string | null

Currency filter (ISO 4217:2015)

int32
int32
Defaults to 50
string
enum

Sort Direction: Asc / Desc

Allowed:
string | null
Defaults to lastOrderPlacedAt

Pass the field that you want to sort by lastOrderPlacedAt or totalOrders

boolean | null

Filter customers who have opted in for marketing

Responses

400

Incorrect input

500

An irrecoverable error occured

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json