GET:customers/page.json

Description

Get all customers of a given shop.

See also: Pagination.

Permission bit: "customers.read"

Topic: Customers

Query Parameters

created_at_max: String

Filter output by creation date, upper boundary

Example: ?created_at_max=2014-09-04T12:23:34Z

Timestamp (RFC 3339)

created_at_min: String

Filter output by creation date, lower boundary

Example: ?created_at_min=2014-09-04T12:23:34Z

Timestamp (RFC 3339)

customer_group_id: String

Show only customers from a certain customer group

Example: ?customer_group_id=str

deleted: Boolean

Include deleted items into result where applicable

Example: ?deleted=true

last_key: String

Key of the last item from previous page. See also: Pagination

Example: ?last_key=str

limit: Int

Return up to N entries (pagination). See also: Pagination

Example: ?limit=5

offset: Int

Skip N entries (pagination). See also: Pagination

Example: ?offset=5

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

sort_by: CustomersPageSortBy

Whether to sort output in some specific way. See also: Pagination

Example: ?sort_by=created_at

sort_desc: Boolean

Whether to use descending sort order. See also: Pagination

Example: ?sort_desc=true

type: CustomerCategory

Filter customers output by a customer type

Example: ?type=accepts_marketing

updated_at_max: String

Filter output by last update date, upper boundary

Example: ?updated_at_max=2014-09-04T12:23:34Z

Timestamp (RFC 3339)

updated_at_min: String

Filter output by last update date, lower boundary

Example: ?updated_at_min=2014-09-04T12:23:34Z

Timestamp (RFC 3339)

Response Body

CustomerPage

Response Body Type

Loading module