---
title: "List accessible brands"
method: GET
path: "/api/v1/public/brands/"
tags: ["Public: Brands"]
---

# List accessible brands

`GET /api/v1/public/brands/`

## Request

- Base URL: `https://api.iterant.ai`
- URL: `https://api.iterant.ai/api/v1/public/brands/`
- Auth: HTTP bearer

The brands this credential can read, with their slug, site and how much work is outstanding on each. Call this first when the brand is not already known: every other route takes a `brandSlug`.

An org-scoped key returns every brand in the organization; a brand-pinned key returns exactly its own.

## Query parameters

- `limit` string
- `offset` string
- `responseFormat` 'concise' | 'detailed'

## Response `200`

- PublicBrandList: The schema for what ``paginated`` builds. Kept beside it deliberately. A list operation whose ``responses`` named the *item* serializer with ``many=True`` published a bare array while the runtime returned this object, so a generated client broke on its first call. Subclasses add ``items``: each operation needs its own named component or the item type is erased.
  - `total` integer, required: Rows matching the query, before `limit` and `offset`.
  - `offset` integer, required: Rows skipped. Echoed back so a caller can page without bookkeeping.
  - `limit` integer, required: Cap actually applied, which may be lower than the one requested.
  - `note` string, required: How to narrow, when the cap hid rows. Empty when the response is the whole answer.
  - `items` PublicBrandSummary[], required
    - `brandSlug` string, required
    - `name` string, required
    - `websiteUrl` string, required
    - `status` string
    - `defaultLanguage` string
    - `publishedPages` integer, required
    - `openOpportunities` integer, required

## Other responses

- `400`
- `401`
- `405`
- `406`
- `415`
- `429`
- `500`

---

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