Skip to main content
GET
List Customers

List Customers

Returns a paginated list of customers for the store. Requires the read_customers scope.

Request

Parameters

integer
default:"1"
Page number for pagination
integer
default:"50"
Number of items per page
string
Filter by exact email address

Response

The response is a bare object keyed by customers containing an array of customer objects. Pagination is conveyed via the standard Link response header (rel="next" / rel="previous") rather than a body field.
array
Array of customer objects
RFC-5988 pagination links. Follow rel="next" until it is absent.

Example Response

Errors