List Brands

GET

/api/v1/brands

const url = 'https://api.ultimateteam.ai/api/v1/brands';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/brands \
  --header 'X-API-Key: <X-API-Key>'

List all brands for the authenticated tenant.

Authorizations

ApiKeyAuth

Responses

200

Successful Response

application/json

Response List Brands Api V1 Brands Get

Array<object>

BrandConfig

Full brand configuration snapshot (read model).

object

contact_info

BrandContactInfo

Contact details shown in branded communications.

object

phone

Any of:

string
null

string

reply_to_email

Any of:

string
null

string format: email

support_email

Any of:

string
null

string format: email

custom_hostname

Any of:

string
null

string

custom_hostname_status

Custom Hostname Status

string

default: not_configured

Allowed values: not_configured pending_verification pending_ssl active blocked failed

required

string format: uuid

logo_url

Any of:

string
null

string format: uri

>= 1 characters <= 2083 characters

name

required

Name

string

>= 1 characters <= 255 characters

personality

BrandPersonality

Agent persona overrides for a brand.

object

formality

Formality

integer

default: 5 <= 10

industry_focus

Any of:

string
null

string

tone

Tone

string

default: professional

Allowed values: formal professional casual friendly

voice_keywords

Voice Keywords

Array<string>

<= 10 items

sending_domain

Any of:

string
null

string

sending_domain_status

Sending Domain Status

string

default: not_configured

Allowed values: not_configured pending_verification verified failed

slug

required

Slug

string

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

tenant_id

required

Tenant Id

string format: uuid

theme

BrandTheme

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

object

background_color

Background Color

string

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

primary_color

Primary Color

string

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

text_color

Text Color

string

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

Example

[
  {
    "custom_hostname_status": "not_configured",
    "personality": {
      "formality": 5,
      "tone": "formal"
    },
    "sending_domain_status": "not_configured",
    "theme": {
      "background_color": "#1A1A1A",
      "primary_color": "#C8A951",
      "text_color": "#F5F0EB"
    }
  }
]