---
title: "Every brand this key may read"
method: GET
path: "/brands"
---

# Every brand this key may read

`GET /brands`

## Request

- Base URL: `https://app.aimentiontracker.ai/api/v1`
- URL: `https://app.aimentiontracker.ai/api/v1/brands`
- Auth: API key in header `X-API-Key`

The ids to pass as ?brand=. A pinned key sees only its own.

## Response `200`

OK

- object
  - `data` Brand[], required
    - `id` string, required: The workspace public id. Pass as ?brand=.
    - `name` string, required: Brand name.
    - `domain` string, nullable: The brand's own domain, null before setup finishes.
    - `configured` boolean, required: False means setup was never finished. Data endpoints return 404 brand_not_configured for one of these rather than a page of zeroes, which would read as measured absence.
    - `active_prompts` integer, required: Prompts currently running for this brand.
    - `market` object
      - `location_code` integer, nullable: DataForSEO location code.
      - `language_code` string, nullable: ISO language code.
    - `last_collected_at` string, nullable: ISO timestamp of the most recent stored answer.
  - `meta` object, required
    - `generated_at` string, date-time
    - `brand` BrandRef: Which brand a response describes. Present in meta on every data endpoint.
      - `id` string, required: Pass as ?brand=.
      - `name` string, required: Display name.
    - `note` string
    - `pinned` boolean: True when this key is bound to one brand.

## Other responses

- `400`: brand_required, or a cursor that does not belong to this brand.
- `401`: Missing, malformed, revoked or expired key.
- `402`: The organisation has never subscribed, or the plan excludes the API.
- `403`: The key lacks the required scope.
- `404`: No such brand, or the brand has not finished setup.
- `429`: Rate limit exceeded. Carries Retry-After.

---

[API](https://skmtc.dev/aimentiontracker/apis/aimentiontracker-api.md) · [All operations](https://skmtc.dev/aimentiontracker/apis/aimentiontracker-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aimentiontracker/apis/aimentiontracker-api/revisions/c3329178c84c?raw)