Get brand by ID

GET

/api/brands/{brandId}

Production

Retrieves a single brand by its unique identifier. Returns the full brand configuration including visual identity, email settings, and AI sender persona.

Authorizations

bearerAuth

Parameters

Path Parameters

brandId

required

string format: uuid

The unique identifier of the brand to retrieve.

Responses

200

The brand was found and returned.

A brand represents a distinct customer-facing identity within your tenant. Each brand has its own visual identity, tone of voice, and email sending configuration. Workspaces are organized under brands.

object

required

Unique identifier for the brand.

string format: uuid

Example

b1a2c3d4-5678-9abc-def0-1234567890ab

tenantId

required

The tenant this brand belongs to.

string format: uuid

Example

a0b1c2d3-4567-89ab-cdef-0123456789ab

name

required

Display name of the brand, shown in the dashboard and used in email communications.

string

Example

Acme Industrial Supply

slug

required

URL-safe identifier derived from the brand name. Used in routing and subdomains.

string

Example

acme-industrial-supply

logoUrl

URL of the brand logo image, hosted on S3. Upload via the brand logo endpoint. Accepts JPEG, PNG, or WebP up to 5 MB.

string | null

Example

https://cdn.ohallo.eu/tenants/a0b1c2d3/brands/b1a2c3d4/logo.png

primaryColor

Primary brand color as a hex code. Used in email templates and widgets.

string | null

Example

#0166A3

secondaryColor

Secondary brand color as a hex code.

string | null

Example

#F59E0B

emailFromName

required

The sender name used in outbound emails for this brand (the ‘From’ display name).

string

Example

Acme Support

emailSignatureHtml

HTML email signature appended to outbound emails sent under this brand.

string | null

Example

<p>Best regards,<br>The Acme Team</p>

emailSignatureText

Plain-text email signature, used when the recipient’s email client does not render HTML.

string | null

Example

Best regards,
The Acme Team

aiSenderName

The name shown as the sender when the AI agent sends a message on behalf of this brand.

string | null

Example

Sophie

aiSenderTitle

The job title shown alongside the AI sender name.

string | null

Example

Customer Support Specialist

aiSenderImageUrl

Avatar image URL for the AI sender. Displayed in chat widgets and email templates.

string | null

Example

https://cdn.ohallo.eu/tenants/a0b1c2d3/brands/b1a2c3d4/ai-sender.png

tone

required

The conversational tone the AI uses when responding on behalf of this brand. ‘friendly’ is casual and warm, ‘professional’ is balanced, ‘formal’ is corporate-appropriate, and ‘trade’ is suited for B2B trade and industrial contexts.

string

Allowed values: friendly professional formal trade

Example

professional

brandInstructions

Free-text instructions that guide the AI when operating under this brand. Use this to specify brand-specific language, topics to avoid, or communication guidelines.

string | null

Example

Always refer to the company as 'Acme' (never 'ACME'). Sign off with 'Happy to help further.'

createdAt

required

Timestamp when the brand was created.

string format: date-time

Example

2026-01-15T09:30:00.000Z

updatedAt

required

Timestamp when the brand was last updated.

string format: date-time

Example

2026-03-10T14:22:00.000Z

404

No brand exists with the given ID in the authenticated tenant.

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