Retrieves a list of customers

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Metadata
fast_search
object

Flag to enable fast search mode through Elastic Service

fields
object

Fields to display in the response

offset
object

Offset from where to start the search

limit
object

Limit the number of rows

email
object
firstname
object

First name of the customer

lastname
object

Last name of the customer

order
object

Displays different options for ordering the customers

total_amount
object

Filter customers by the total amount of their purchases

nb_orders
object

Filter customers by the quantity of orders

subscribe_newsletter
object

Enable newsletter subscription

subscribe_promotion
object

Enable promotion subscription

abandoned_cart
object

Enable abandoned cart email

order_subscriptions
object
state
object

Define the state of the user

country
object

Country of the customer

tag
object

Tag of the customer

order_dates
object

Filter customers by the date of theirs orders

order_states
object

State of the orders purchased by the customer

payment_states
object

State of the payment made by the customer

shipping_states
object

Shipping states of the orders of the customer

flag
object

Custom labels with values assigned to customers in fraud engine

ugroupIDs
object

User group internal identifier

string
required

The Client identifier provided by Scalefast

string
required

The OAuth2 access token

Response

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