API reference
Search…
⌃K
Links

List all customer groups

How to fetch a collection of customer groups via API
To fetch a collection of customer groups, send a GET request to the /api/customer_groups endpoint.

Request

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

Example

Request
Response
The following request fetches a collection of customer groups:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/customer_groups/' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:
{
"data": [
{
"id": "xYZkjABcde",
"type": "customer_groups",
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_groups/xYZkjABcde"
},
"attributes": {
"name": "VIP",
"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": {
"customers": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_groups/xYZkjABcde/relationships/customers",
"related": "https://yourdomain.commercelayer.io/api/customer_groups/xYZkjABcde/customers"
}
},
"markets": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_groups/xYZkjABcde/relationships/markets",
"related": "https://yourdomain.commercelayer.io/api/customer_groups/xYZkjABcde/markets"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_groups/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/customer_groups/xYZkjABcde/attachments"
}
}
},
"meta": {
"mode": "test"
}
},
{
"other": "... 9 customer_groups (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/customer_groups?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/customer_groups?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/customer_groups?page[number]=14&page[size]=10"
}
}
Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of customer groups can be sorted by the following fields:
  • name
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin

Filterable fields

The list of customer groups can be filtered by the following fields:

Attributes

  • name
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin

Relationships

  • customers
  • markets
  • attachments