Get Brand

GET

/api/v1/brands/{brand_id}

• Production
• Local development

Get a single brand by ID.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

brand_id

required

string format: uuid

Responses

200

Successful Response

Full brand configuration snapshot (read model).

object

contact_info

Contact details shown in branded communications.

object

phone

Any of:

string

string

null

null

reply_to_email

Any of:

string

string format: email

null

null

support_email

Any of:

string

string format: email

null

null

custom_hostname

Any of:

string

string

null

null

custom_hostname_status

string

default: not_configured

Allowed values: not_configured pending_verification pending_ssl active blocked failed

id

required

string format: uuid

logo_url

Any of:

string

string format: uri

>= 1 characters <= 2083 characters

null

null

name

required

string

>= 1 characters <= 255 characters

personality

Agent persona overrides for a brand.

object

formality

integer

default: 5 <= 10

industry_focus

Any of:

string

string

null

null

tone

string

default: professional

Allowed values: formal professional casual friendly

voice_keywords

Array<string>

<= 10 items

sending_domain

Any of:

string

string

null

null

sending_domain_status

string

default: not_configured

Allowed values: not_configured pending_verification verified failed

slug

required

string

>= 1 characters <= 100 characters /^[a-z0-9-]+$/

tenant_id

required

string format: uuid

theme

Visual theme for a brand (hex color codes only).

object

background_color

string

default: #1A1A1A /^#[0-9A-Fa-f]{6}$/

primary_color

string

default: #C8A951 /^#[0-9A-Fa-f]{6}$/

text_color

string

default: #F5F0EB /^#[0-9A-Fa-f]{6}$/

422

Validation Error

object

detail

Array<object>

object

ctx

object

input

loc

required

Array

msg

required

string

type

required

string