List all customers

get

https://api.heymantle.com/v1/customers

Get a paginated list of customers with optional filters and sorting.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

Defaults to 0

The page number to retrieve

take

integer

Defaults to 25

The number of records to retrieve

sort

string

The field to sort by

sortDirection

string

enum

Defaults to desc

The direction to sort by

Allowed:

cursor

string

The cursor to paginate from

string

The search term to filter by

minUpdatedAt

date-time

The minimum date/time (ISO 8601) of the last update to the Customer

maxUpdatedAt

date-time

The maximum date/time (ISO 8601) of the last update to the Customer

appIds

array of strings

An optional list of appIds to filter customers by (they must have a previous or current installation of the app).

appIds

shopifyShopDomain

string

An optional shopify shop domain (myshopify.com domain) to filter customers by.

domain

string

An optional custom domain to filter customers by (e.g. example.com).

shopifyShopId

string

An optional shopify shop id to filter customers by.

Email addresses to filter customers by. Can be passed as an array (email=[email protected]&email=[email protected]) or a single string. Returns customers with emails matching any of the provided addresses.

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of customers.

401Unauthorized

403Forbidden