List all customers

How to fetch a collection of customers via API

To fetch a collection of customers, send a GET request to the /api/customers endpoint.

Request

GET https://yourdomain.commercelayer.io/api/customers

Example

The following request fetches a collection of customers:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/customers/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of customers can be sorted by the following fields:

Attributes

  • email

  • status

  • total_orders_count

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Relationships

  • customer_group

Filterable fields

The list of customers can be filtered by the following fields:

Attributes

  • email

  • status

  • total_orders_count

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • customer_group

  • customer_addresses

  • customer_payment_sources

  • customer_subscriptions

  • order_subscriptions

  • returns

  • sku_lists

  • attachments

  • events

  • tags

Last updated