Public: Brands

List accessible brands

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.

get/api/v1/public/brands/

Request

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

Query parameters

limitstring

1-100, default 25.

offsetstring

Rows to skip.

responseFormat'concise' | 'detailed'

How much to return. concise (the default) omits long-form text: briefs, outlines, evidence, passage excerpts, per-dimension breakdowns. detailed includes it and costs several times the tokens.

Response

totalinteger required

Rows matching the query, before limit and offset.

offsetinteger required

Rows skipped. Echoed back so a caller can page without bookkeeping.

limitinteger required

Cap actually applied, which may be lower than the one requested.

notestring required

How to narrow, when the cap hid rows. Empty when the response is the whole answer.

Changes

No recorded changes to this operation across all 1 revision of this API.