Light Mode

List Customer Groups

GET/customers/groups

Last modified: 12 days ago

This endpoint allows you to list all the customer groups in your store.

:::info[Information]
Customer groups segment your customers into smaller, targeted groups rather than a default group. This enables tailored service, better understanding of their needs, and personalized treatment for each group.
:::

`customers.read`- Customers Read Only

Request

Query Params

page

integer

optional

The Pagination page number

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 2075683582,
      "name": "VIP Customers"
    },
    {
      "id": 2075683583,
      "name": "Golden Customers"
    }
  ],
  "pagination": {
    "count": 2,
    "total": 2,
    "perPage": 15,
    "currentPage": 1,
    "totalPages": 1,
    "links": []
  }
}

Last modified: 12 days ago