Skip to content
UltimateTeam.ai Docs

Get Brand

GET
/api/v1/brands/{brand_id}
curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Get a single brand by ID.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
brand_id
required
Brand Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
BrandConfig

Full brand configuration snapshot (read model).

object
contact_info
BrandContactInfo

Contact details shown in branded communications.

object
phone
Any of:
string
reply_to_email
Any of:
string format: email
support_email
Any of:
string format: email
custom_hostname
Any of:
string
custom_hostname_status
Custom Hostname Status
string
default: not_configured
Allowed values: not_configured pending_verification pending_ssl active blocked failed
id
required
Id
string format: uuid
logo_url
Any of:
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
tone
Tone
string
default: professional
Allowed values: formal professional casual friendly
voice_keywords
Voice Keywords
Array<string>
<= 10 items
sending_domain
Any of:
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"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}