Skip to main content
GET
List your organisation’s brands, newest first.

Authorizations

Authorization
string
header
required

Authorization: Bearer vsk_live_…. Chosen over a bespoke X-API-KEY header because every client, proxy and log-redaction rule already knows this one. What a key may DO is its scopes — see x-scopes at the root of this document and x-required-scope on each operation. The scope list is not written here because OpenAPI reserves a requirement’s scope array for oauth2 and openIdConnect and requires it to be empty for an http scheme.

Query Parameters

limit
integer
default:25

How many to return. A value outside the range is refused, not clamped. How many brands to return.

Required range: 1 <= x <= 100
cursor
string<uuid>

The next_cursor from the previous page, with the same include_archived. Opaque. Where to resume.

include_archived
enum<string>

true to list archived brands as well as live ones. Anything but true or false is refused. Whether to include archived brands.

Available options:
true,
false

Response

A page of brands, newest first, with the cursor for the next.

The page.

data
object[]
required

The brands on this page.

has_more
boolean
required

Whether another page follows.

next_cursor
string<uuid> | null
required

Pass as cursor for the next page; null on the last. Opaque.