Skip to main content
GET
Read back your brand's platform configuration

Authorizations

Authorization
string
header
required

Per-client API key (M2M). Presented as Authorization: Bearer <key>.

Headers

X-Brand-Id
string
required

Your brand id (brd_...). It must be one of the brands your API key's account owns; with a publishable key it must be the one brand the key was issued for. A missing or malformed value is refused with 400, and an unknown or foreign brand with 404.

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$

Path Parameters

brand_id
string
required

the brand whose configuration to read (must match X-Brand-Id).

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$

Response

the brand's configuration (clinically inert by construction)

data
object
required

A brand's platform configuration as the platform holds it — clinically inert BY CONSTRUCTION (the validator enforces a top-level allowlist + a recursive clinical-shaped-key denylist). The your readback and the platform staff view return this EXACT shape. Presentation and commercial reach only; never a clinical field. additionalProperties:false mirrors the validator's top-level allowlist.

patient_readiness
object

whether the brand is ready for patients and what is still missing: the same verdict the intake resolve reports. Present whenever the platform's readiness check is available.