Skip to main content
GET
Get Brand Settings

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer hrld_....

Path Parameters

brand_id
string<uuid>
required

The brand's UUID from listBrands.

Response

Successful Response

autonomy
AutonomyPayload · object
required

A brand's Autonomy as the page draws it: the two switches, the preset, the 3 x 4 grid, and what the plan locks.

brand_id
string<uuid>
required
connections
V1ConnectionStatus · object[]
required
deletion_scheduled_for
string | null
required
description
string | null
required
domain
string
required
features
PlanFeatures · object
required

The Plus-only parts a read can carry, which a plan without them answers with their empty value rather than a refusal.

meta
Meta · object
required

Normalized query and newest included scan.

name
string
required
owned_domains
OwnedDomainsDraft · object
required

The review gate over which domains count as this brand's own.

profile
BrandProfilePage · object
required

The configuration page, whole. No band and no score: nothing here is a measurement, and everything here decides one.

prompts_reserved
integer | null
required

Always null: no brand reserves prompts, segments are the unit allocated.

prompts_used
integer
required

Active prompts of the brand's active topics in live segments. A paused brand keeps this count while spending no organization slots.