Skip to main content
GET
The active brand profile

Authorizations

Authorization
string
header
required

A workspace API key issued in Settings → Developer, sent as Bearer sk_….

Response

The active brand profile.

version
integer
required
Example:

3

positioning
string | null
required
audience
string | null
required
productDescription
string | null
required
tone
string | null
required
contentStyle
string | null
required
competitors
string[]
required
competitorRoster
object[]
required

How the next scan matches each competitor: its domain and other names. Set them with POST or PATCH /v1/brand/competitors.

excludedTopics
string[]
required
competitorsPinnedAt
string | null
required

ISO-8601 UTC when the competitor list was pinned; null when not pinned.

notConfusedWith
object[]
required

Other products that share the brand's name. An answer about one of them is not counted as a mention of the brand. source is user (set by a person or agent) or research (added when research found answers citing it). Set the list with PATCH /v1/brand.