Get a customer group

GET

api

{team_slug}

{app_slug}

customer-groups

{customer_group_id}

Error

A valid request URL is required to generate request examples

{
  "data": {
    "app_id": "<string>",
    "created_at": "<string>",
    "discount_percentage": 123,
    "discount_percentage_decimals": 123,
    "id": "<string>",
    "merchant_users": [
      {
        "email": "<string>",
        "id": "<string>"
      }
    ],
    "merchant_users_total": 123,
    "name": "<string>",
    "organisations": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "organisations_total": 123,
    "slug": "<string>",
    "store_group_id": "<string>",
    "type": "<string>",
    "updated_at": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Authorizations

Authorization

string

header

required

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

Path Parameters

app_slug

string

required

App slug

team_slug

string

required

Team slug

customer_group_id

string

required

Customer Group ID

Query Parameters

merchant-users-page

integer

Merchant users page number (default: 1)

merchant-users-per-page

integer

Merchant users per page (default: 20, max: 100)

organisations-page

integer

Organisations page number (default: 1)

organisations-per-page

integer

Organisations per page (default: 20, max: 100)

Response

Got Customer group successfully

data

object

Show child attributes

details

string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

success

boolean

Error

A valid request URL is required to generate request examples

{
  "data": {
    "app_id": "<string>",
    "created_at": "<string>",
    "discount_percentage": 123,
    "discount_percentage_decimals": 123,
    "id": "<string>",
    "merchant_users": [
      {
        "email": "<string>",
        "id": "<string>"
      }
    ],
    "merchant_users_total": 123,
    "name": "<string>",
    "organisations": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "organisations_total": 123,
    "slug": "<string>",
    "store_group_id": "<string>",
    "type": "<string>",
    "updated_at": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Management API

Shopper API

Customers API

Digital Assets Management API

Authorizations

Path Parameters

Query Parameters

Response