身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/branding \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
The name, logo, colour and links the signed-in customer's dashboard paints itself with — their agency's or reseller's if they are white-labelled, otherwise Zinn®'s. **Always answers, for every authenticated caller.** An organisation with no brand of its own is not a `404`: it receives the platform identity with `is_white_label: false`. A nullable answer would make every client invent its own fallback, and the second such client is the leak this feature exists to close. Resolved by walking **up** the organisation tree to the org that owns the brand, and gated on the `white_label` entitlement held by that owner — never by the client reading it, who holds no such entitlement and never will. ⛔ Not gated on a permission key. This answers *"what does your screen look like?"*, not *"may you see this data?"* — the payload is the brand the caller is already looking at. It is still authenticated and org-scoped, so one tenant cannot ask what another tenant's panel looks like. **`Cache-Control: private, no-store`** — this response is never stored, by any cache, and that is a tenancy requirement rather than a tuning choice. The URL is `/v1/branding` for every tenant and the organisation travels in `X-Zinn-Org`, so a stored copy is keyed on nothing that separates one tenant from the next. It was `private, max-age=60` until 2026-08-26; `private` bounds a stored copy to one browser profile and **does not** bound it to one tenant, and one browser profile is exactly where an organisation switch happens. Measured before the change: four organisations, one token, one second apart, all four answering with the first one's brand. `Vary: X-Zinn-Org, Authorization` is sent as well, so an intermediary that stores despite `no-store` still cannot serve one tenant's brand to another.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
org_id (query) | string | 否 | Which of the caller's organisations to resolve for. Optional, and only needed by a person who belongs to several. `X-Zinn-Org` stands in for it when it is absent. Accepts **any… |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
name | string | 是 | The name shown in the page title, the sidebar header and the browser tab. |
dashboard_url | string | 是 | Where this brand's panel lives. The brand's own attached hostname when it has one, otherwise the platform panel — never a hostname that does not resolve yet, because a link the… |
support_url | string | 是 | — |
status_url | string | 是 | — |
logo_url | string | 是 | Empty when the brand has set no logo; the client then renders the name. |
primary_colour | string | 是 | Empty when the brand has set no colour; the client then uses its default. |
is_white_label | boolean | 是 | `false` for Zinn®'s own identity. Lets a surface say "this is white-labelled" without comparing the name to a literal. |
is_client_of_reseller | boolean | 是 | `true` only when this brand belongs to an organisation **above** yours — that is, you are a reseller's client rather than the reseller. ⛔ Not the same question as `is_white_labe… |
locales | string[] | 是 | The languages this panel may be shown in, in registry order. Every language we ship, unless the caller is a reseller's client and that reseller narrowed the list. Never empty. S… |
default_locale | string | 是 | The language a new account under this brand starts in. Always a member of `locales`. |
locales_restricted | boolean | 是 | `true` when a reseller narrowed the list, so a surface can explain why a language is missing instead of looking broken. |
language_switcher | boolean | 是 | `false` when the reseller has removed the language control from their clients' panel. Render no picker — not a disabled one. `locales` stays populated regardless: hiding a contr… |
currencies | string[] | 是 | The currencies this panel may quote in, in registry order. Every currency we can charge, unless the caller is a reseller's client and that reseller narrowed the list. Never empty. |
default_currency | string | 是 | What a viewer under this brand is quoted in before they choose. Always a member of `currencies`. |
currencies_restricted | boolean | 是 | `true` when a reseller narrowed the list, so a surface can explain why a currency is missing instead of looking broken. |
currency_switcher | boolean | 是 | `false` when the reseller has removed the currency control. Every client of that reseller is then quoted in `default_currency`. |
palette | object | 是 | Design-system colour tokens the brand chose, `{token: "#rrggbb"}`. **Empty for the platform**, which means *"use the design system's own"* — expressed as absence rather than as… |
font_stack | string | 是 | A complete CSS `font-family` value, fallbacks included. Never a bare family name: a brand whose webfont fails to load must land somewhere chosen, not on the browser's default se… |
font_css_url | string | 是 | A stylesheet installing a self-hosted Google family, or `""` for a catalogue font that needs no bytes. ⛔ Served from **our** origin, never `fonts.googleapis.com`. A `<link>` to… |
nav_position | string | 是 | — |
density | string | 是 | — |
corner_radius | string | 是 | — |
colour_scheme | string | 是 | The scheme a first visit lands on. |
favicon_url | string | 是 | The brand's icon, already falling back to its logo. Empty means *"leave whatever the surface has"* — never our mark, because on a reseller's hostname that is the leak. |
email_logo_url | string | 是 | The mark for transactional mail; falls back to the panel logo. |
menu_items | BrandNavLink[] | 是 | Custom navigation links the provider added, **already filtered** to what this reader may see. |
此端点可能返回的错误
401 · 429