List contact groups (flat)

Returns customer groups (segments). Optionally filter by shop_id or seller_id; without either, returns groups across all of the account’s sellers.

GET/contact_groups

Authorization

AuthorizationBearer token (JWT) · headerrequired

Query parameters

shop_idinteger

seller_idinteger

Responses

200

Contact groups list

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

shop_idqueryseller_idquery

Request

curl -s -H "Authorization: Bearer $BOLDER_TOKEN" \
  "https://api.onbolder.com/v2/contact_groups?seller_id=5"

curl -X GET 'https://api.onbolder.com/v2/contact_groups' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/contact_groups", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/contact_groups",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "_class": [
    "results",
    "contactGroups"
  ],
  "total_items": 2,
  "_embedded": {
    "items": [
      {
        "id": 1,
        "name": "VIP Customers",
        "customers_count": 42
      }
    ]
  }
}