Get a brand

GET

/api/brands/{brandId}

• Production

Returns one brand. Requires the brands:read scope.

Authorizations

• bearerAuth

Parameters

Path Parameters

brandId

required

string format: uuid

The unique identifier of the brand.

Responses

200

The brand.

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

404

No brand with this ID is within the caller’s reach.

Standard error response returned by all endpoints on failure.

object

error

required

A human-readable error message describing what went wrong.

string

Example

Conversation not found

code

A machine-readable reason on some refusals, for example ‘key_lock’ when an API key’s brand or workspace restriction does not cover the action.

string

Example

key_lock

missing_scopes

On a 403 for an API key without a scope the endpoint requires: the scopes the key lacks.

Array<string>

Example

[
  "mcp:write"
]

entryId

On a 409 with code duplicate_question or duplicate_rule_text: the knowledge base entry or policy that already holds the question or rule text.

string format: uuid

Example

11223344-5566-4788-99aa-bbccddeeff00

connectionId

On a 422 about one MCP connection a request names, from an assignment or an agent create or update (a connection that does not exist, one listed twice, or one that does not declare a tool named): the connection, as the request named it.

string

undeclaredTools

On the same 422: the tool names the connection does not declare.

Array<string>

Example

[
  "get_orders"
]

declaredTools

On the same 422: the tools the connection declares.

Array<string>

Example

[
  "get_order",
  "search_orders"
]