Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List customer groups

Lists customer groups (minimal fields) with pagination.

GET/api/v2/{team_slug}/{app_slug}/customer-groups
Authorization
AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters
team_slugstringrequired
app_slugstringrequired
Query parameters
pageinteger
per-pageinteger
searchstring
customer-group-idstring[]

Repeatable customer group id

typestring
store-group-idstring<uuid>
Responses
200

OK

dataCustomerGroupBase[]required
Show properties
Array of CustomerGroupBase
idUUIDrequired
namestringrequired
slugstringrequired
typestringrequired
discount_percentageinteger | null
discount_percentage_decimalsinteger | null
created_atstring<date-time>required
updated_atstring<date-time>required
total_pagesintegerrequired
total_itemsintegerrequired
400

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
401

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
403

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
500

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.enad.io/api/v2/string/string/customer-groups' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "type": "string",
      "discount_percentage": 0,
      "discount_percentage_decimals": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "total_pages": 0,
  "total_items": 0
}