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

KeyDatatypeRequiredDescription
pagestringThe Pagination page number

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;success&quot;:&quot;\u003cstring\u003e&quot;,&quot;data&quot;:[{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;conditions&quot;:{&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;symbol&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;},&quot;features&quot;:{&quot;payment_method&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;shipping&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]}},{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;conditions&quot;:{&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;symbol&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cnumber\u003e&quot;},&quot;features&quot;:{&quot;payment_method&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;shipping&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]}}],&quot;pagination&quot;:{&quot;count&quot;:&quot;\u003cnumber\u003e&quot;,&quot;total&quot;:&quot;\u003cnumber\u003e&quot;,&quot;perPage&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currentPage&quot;:&quot;\u003cnumber\u003e&quot;,&quot;totalPages&quot;:&quot;\u003cnumber\u003e&quot;,&quot;links&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]}}