`GET` customer.list.json

Summary: —
Operation ID: CustomerList
Auth: unknown

Description

Get list of customers from store.

Parameters (14)

avail (boolean, query, optional, default: True)

Defines category's visibility status

count (integer, query, optional, default: 10)

This parameter sets the entity amount that has to be retrieved. Max allowed count=250

created_from (string, query, optional)

Retrieve entities from their creation date

created_to (string, query, optional)

Retrieve entities to their creation date

customer_list_id (string, query, optional)

The numeric ID of the customer list in Demandware.

exclude (string, query, optional)

Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all

group_id (string, query, optional)

Customer group_id

modified_from (string, query, optional)

Retrieve entities from their modification date

modified_to (string, query, optional)

Retrieve entities to their modification date

page_cursor (string, query, optional)

Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)

params (string, query, optional, default: id,email,first_name,last_name)

Set this parameter in order to choose which entity fields you want to retrieve

response_fields (string, query, optional)

Set this parameter in order to choose which entity fields you want to retrieve

start (integer, query, optional, default: 0)

This parameter sets the number from which you want to get entities

store_id (string, query, optional)

Retrieves customers specified by store id

No probe data for this endpoint yet.