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

200Contact groups list

Request

curl -X GET "https://api.onbolder.com/v2/contact_groups" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

import requests

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

Response

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