List brands

GET

/api/brands

• Production

Lists the brands within the caller’s reach. An API key restricted to a brand or workspace sees that brand. Requires the brands:read scope.

Authorizations

• bearerAuth

Responses

200

The brands.

Array<object>

A brand: how customers know the business. Workspaces sit under a brand.

object

id

required

string format: uuid

tenantId

required

The account the brand belongs to.

string format: uuid

name

required

string

Example

Example Company

slug

required

string

Example

example-company

status

required

string

Allowed values: active inactive

logoUrl

string | null

primaryColor

string | null

secondaryColor

string | null

emailFromName

required

string

Example

Example Company

personaInstructions

string | null

brandInstructions

string | null

aiSenderName

string | null

aiSenderTitle

string | null

aiSenderImageUrl

string | null

supportedLanguages

required

Array<string>

primaryLanguage

string | null

personaVoice

The assistant’s voice per language on voice channels.

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time