Skip to content
MentionBird.ai
Browse the documentation

List Tracked Brands

List every brand this workspace tracks. Call this first — other endpoints take the brand name exactly as returned here.

GET /brands/tracked

Example request

curl -H "Authorization: Bearer $MENTIONBIRD_API_KEY" \
  "https://api.mentionbird.ai/api/v1/brands/tracked"

Example response

Recorded from a live call against a demo workspace, so the shape is exactly what the endpoint returns.

{
  "has_more": false,
  "items": [
    {
      "brand": "Acme",
      "domain": "acme.com",
      "domains": [
        {
          "domain": "acme.com",
          "include_subdomains": true
        }
      ]
    }
  ],
  "returned_count": 1,
  "total_count": 1
}

Responses

200
List of tracked brands. domains lists the domains this workspace declared as the brand's own, each with include_subdomains; they are what the 'yours' ownership label matches, and an empty list means none are declared. domain is the first declared domain, else the brand's public domain, else null.
400
Validation error — check the message in `error.message`.
401
Unauthorized — missing, invalid or revoked bearer token.
403
Forbidden — the plan lacks API access, the key is read-only, or addTrackedBrand would pass the tracked-brand limit.
404
Not found — the brand, prompt or resource does not exist.
405
Method not allowed.
429
Too many requests — over the key's per-minute or per-day limit. Wait the seconds in the `Retry-After` header, then retry.
500
Internal error — logged; retry is safe for reads.