Get all brand tags

GET /chat/brand-tags

Bearer token

Headers

X-Popsell-Brand integer Required

The id of the target brand

Query parameters

filter[visibility_chat] integer

Filter by visibility chat
filter[chatVisibleFor] integer

Filter by chat visible for

Responses

200 application/json

Returns the brand tags
Hide response attributes Show response attributes object
- current_page integer(int32)
- data array[object]
  
  Hide data attributes Show data attributes object
  
  id_brand_tag integer(int32)
  
  visibility_chat integer
  
  name string
  
  image string
  
  images array[object]
  
  Hide images attributes Show images attributes object
  
  id_i18n_content integer
  
  lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
  
  content string
  
  names array[object]
  
  Hide names attributes Show names attributes object
  
  id_i18n_content integer
  
  lang string
  
  Values are en_GB, fr_FR, es_ES, or de_DE.
  
  content string
  
  members object
  
  Additional properties are allowed.
  
  Hide members attributes Show members attributes object
  
  id_ambassador integer(int32)
  
  image string
  
  firstname string
  
  lastname string
  
  username string
  
  email string
  
  email_tmp string
  
  active integer(int32)
  
  status integer(int32)
  
  online boolean
  
  true: when last_action_date is less than 5 minutes ago
  
  last_action_date string(date-time)
  
  customer_id string
  
  anonymized boolean
- first_page_url string
- from integer(int32)
- last_page integer(int32)
- last_page_url string
- links array[object]
  
  Hide links attributes Show links attributes object
  
  url string(nullable)
  
  label string
  
  active boolean
- next_page_url string
- path string
- per_page integer(int32)
- prev_page_url string(nullable)
- to integer(int32)
- total integer(int32)
401 application/json

Unauthorized.
Hide response attribute Show response attribute object
- message string
403

Forbidden - You don't have permission to access this route

GET /chat/brand-tags

curl \
 -X GET https://domain.tld/api/v2/chat/brand-tags \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "X-Popsell-Brand: 3"

Response examples (200)

{
  "current_page": 42,
  "data": [
    {
      "id_brand_tag": 42,
      "visibility_chat": 0,
      "name": "groupe",
      "image": "https://superimage.com",
      "images": [
        {
          "id_i18n_content": 42,
          "lang": "en_GB",
          "content": "Hello"
        }
      ],
      "names": [
        {
          "id_i18n_content": 42,
          "lang": "en_GB",
          "content": "Hello"
        }
      ],
      "members": {
        "id_ambassador": 42,
        "image": "string",
        "firstname": "string",
        "lastname": "string",
        "username": "string",
        "email": "string",
        "email_tmp": "string",
        "active": 42,
        "status": 42,
        "online": true,
        "last_action_date": "2025-05-04T09:42:00+00:00",
        "customer_id": "string",
        "anonymized": true
      }
    }
  ],
  "first_page_url": "string",
  "from": 42,
  "last_page": 42,
  "last_page_url": "string",
  "links": [
    {
      "url": "string",
      "label": "string",
      "active": true
    }
  ],
  "next_page_url": "string",
  "path": "string",
  "per_page": 42,
  "prev_page_url": "string",
  "to": 42,
  "total": 42
}

Response examples (401)

{
  "message": "Unauthorized."
}