Skip to content
MentionBird.ai
Browse the documentation

List Brand Aliases

List the extra spellings that count as the brand, or as one of its competitors, when an answer names them.

GET /brands/aliases

Query parameters

Name Type Description
brand required string Tracked brand name, exactly as returned by listTrackedBrands.

Example request

curl -H "Authorization: Bearer $MENTIONBIRD_API_KEY" \
  "https://api.mentionbird.ai/api/v1/brands/aliases?brand=Acme"

Example response

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

{
  "has_more": false,
  "items": [
    {
      "alias": "acme inc",
      "competitor": null,
      "match_mode": "exact"
    },
    {
      "alias": "globex corp",
      "competitor": "Globex",
      "match_mode": "contains"
    }
  ],
  "returned_count": 2,
  "total_count": 2
}

Responses

200
Aliases, the brand's first. competitor is null for the brand's own. match_mode is exact (the whole name in an answer equals the alias, ignoring case) or contains (the name contains it).
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.