List Customer Groups
GET
/customers/groupsThis 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.
:::
Request
The Pagination page number
Request samples
Responses
The unique identifier assigned to a specific group of customers
The name or label for a the Customer Group.
Conditions for group membership, such as total_sales > 100
, determine auto-assignment. For example, customers with sales exceeding 100 are added to the group automatically.
For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.
Number of returned results.
Number of all results.
Number of results per page.
Number of current page.
Number of total pages.
Array of linkes to next and previous pages.
{
"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": []
}
}