List Customer Groups
GET {{baseUrl}}/customers/groups?page=<integer>
This endpoint allows you to list all the customer groups in your store. Customer groups are aiming to divide customers into smaller groups instead of the default customers group to be able to serve them better and to determine their needs and also give each group special treatment.
Scope: customers.read
- Customers Read Only
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
page | string | The Pagination page number |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"status":"\u003cstring\u003e","success":"\u003cstring\u003e","data":[{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","conditions":{"type":"\u003cstring\u003e","symbol":"\u003cstring\u003e","value":"\u003cnumber\u003e"},"features":{"payment_method":["\u003cstring\u003e","\u003cstring\u003e"],"shipping":["\u003cstring\u003e","\u003cstring\u003e"]}},{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","conditions":{"type":"\u003cstring\u003e","symbol":"\u003cstring\u003e","value":"\u003cnumber\u003e"},"features":{"payment_method":["\u003cstring\u003e","\u003cstring\u003e"],"shipping":["\u003cstring\u003e","\u003cstring\u003e"]}}],"pagination":{"count":"\u003cnumber\u003e","total":"\u003cnumber\u003e","perPage":"\u003cnumber\u003e","currentPage":"\u003cnumber\u003e","totalPages":"\u003cnumber\u003e","links":["\u003cstring\u003e","\u003cstring\u003e"]}}