Skip to main content
GET
List your brand's custom domains

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 custom domains to view or manage (must match X-Brand-Id).

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

Response

your brand's custom-domain rows (0, 1, or 2)

data
object
required

your brand's custom-domain rows (0, 1, or 2 — one per kind you have registered).