List all customers
GET https://{{subdomain}}.commercelayer.io/api/customers
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Authorization | string |
RESPONSES
status: OK
{"data":[{"id":"xYZkjABcde","type":"customers","links":{"self":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde"},"attributes":{"email":"john@example.com","status":"prospect","has_password":false,"total_orders_count":6,"shopper_reference":"xxx-yyy-zzz","created_at":"2018-01-01T12:00:00.000Z","updated_at":"2018-01-01T12:00:00.000Z","reference":"ANY-EXTERNAL-REFEFERNCE","reference_origin":"ANY-EXTERNAL-REFEFERNCE-ORIGIN","metadata":{"foo":"bar"}},"relationships":{"customer_group":{"links":{"self":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/customer_group","related":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/customer_group"}},"customer_addresses":{"links":{"self":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/customer_addresses","related":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/customer_addresses"}},"customer_payment_sources":{"links":{"self":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/customer_payment_sources","related":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/customer_payment_sources"}},"customer_subscriptions":{"links":{"self":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/customer_subscriptions","related":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/customer_subscriptions"}},"orders":{"links":{"self":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/orders","related":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/orders"}},"order_subscriptions":{"links":{"self":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/order_subscriptions","related":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/order_subscriptions"}},"returns":{"links":{"self":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/returns","related":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/returns"}},"sku_lists":{"links":{"self":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/sku_lists","related":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/sku_lists"}},"attachments":{"links":{"self":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/attachments","related":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/attachments"}},"events":{"links":{"self":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/events","related":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/events"}},"tags":{"links":{"self":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/tags","related":"https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/tags"}}},"meta":{"mode":"test"}},{"other":"... 9 customers (first page)"}],"meta":{"record_count":140,"page_count":14},"links":{"first":"https://yourdomain.commercelayer.io/api/customers?page[number]=1\u0026page[size]=10","next":"https://yourdomain.commercelayer.io/api/customers?page[number]=2\u0026page[size]=10","last":"https://yourdomain.commercelayer.io/api/customers?page[number]=14\u0026page[size]=10"}}