Skip to main content
GET
One brand, archived or not.

Authorizations

Authorization
string
header
required

Authorization: Bearer vsk_live_…. Chosen over a bespoke X-API-KEY header because every client, proxy and log-redaction rule already knows this one. What a key may DO is its scopes — see x-scopes at the root of this document and x-required-scope on each operation. The scope list is not written here because OpenAPI reserves a requirement’s scope array for oauth2 and openIdConnect and requires it to be empty for an http scheme.

Path Parameters

brandId
string<uuid>
required

The brand’s id, from GET /api/v1/brands or Settings → Brands. A brand id.

Example:

"5d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d"

Response

The brand as it stands now: its colours, its logo, whether it is the default, and its embedding origins.

The brand.

id
string<uuid>
required

The brand’s id, as brand_id takes it on an envelope create.

name
string
required

The brand’s name, shown on the signing page when it has no logo.

email_display_name
string | null
required

The name after “via” on the From line of its emails to signers; null means name.

primary_color
string
required

The signer’s action buttons, as #rrggbb.

primary_text_color
string
required

The text on those buttons, as #rrggbb.

logo
object | null
required

The logo, or null when the brand has none. ⚠️ url is public and needs no credential, as it must: it is the same address every signing page and email of the brand loads. A new logo is a new url; the bytes behind one never change.

is_default
boolean
required

Whether an envelope created without a brand_id goes out under this brand. One live brand at most.

embed_origins
string[]
required

The bare origins allowed to frame this brand’s signing pages, sorted; at most 20. Empty means none may.

A bare origin: https://, a host and an optional port.

archived_at
string<date-time> | null
required

When the brand was archived, or null for a live brand.

created_at
string<date-time>
required

When the brand was created.

updated_at
string<date-time>
required

When the brand last changed, including an embedding origin added or removed.