identity

GET /v1/branding

The brand this customer's panel renders under.

എല്ലാ identity എൻഡ്‌പോയിന്റുകളും

പ്രമാണീകരണം

ബെയറർ ടോക്കണായി ഒരു API കീ അയക്കുക. ഈ എൻഡ്‌പോയിന്റ് അതിന്റെ സ്പെസിഫിക്കേഷനിൽ ഒരു പ്രത്യേക അനുമതി വ്യക്തമാക്കിയിട്ടില്ല, അതിനാൽ അനുമാനിക്കുന്നതിന് പകരം നിങ്ങളുടെ കീയ്ക്ക് ഏറ്റവും കുറഞ്ഞത് ആവശ്യമുള്ളത് നൽകുകയും പ്രതികരണം പരിശോധിക്കുകയും ചെയ്യുക.

നിങ്ങളുടെ ഓർഗനൈസേഷൻ ഐഡി നൽകേണ്ട ഇടം

ഈ എൻഡ്‌പോയിന്റ് org_id എന്നത് ഒരു ക്വറി പരാമീറ്ററായി സ്വീകരിക്കുന്നു. ഇത് ഒഴിവാക്കിയാൽ കോൾ നിങ്ങളുടെ മുഴുവൻ ടെനൻസി സബ്‌ട്രീയെയും ഉൾക്കൊള്ളുന്നു; കോൾ ഒരു സ്ഥാപനത്തിലേക്ക് മാത്രമായി ചുരുക്കാൻ ഇത് അയക്കുക.

നിങ്ങളുടെ ഡാഷ്‌ബോർഡിലെ API കീകൾക്കായുള്ള സ്ക്രീനിൽ കീയ്ക്ക് തൊട്ടടുത്തായി നിങ്ങളുടെ ഓർഗനൈസേഷൻ ഐഡി ലഭ്യമാണ്. നിങ്ങൾ നടത്തുന്ന എല്ലാ കോളുകളിലും ഉപയോഗിക്കുന്നത് ഒരേ ഐഡി തന്നെയാണ്.

ശ്രമിച്ച് നോക്കൂ

കോണമ്ബ്രക്കറ്റുകളിലുള്ള ഏതും നിങ്ങളുടെ സ്വന്തം മൂല്യങ്ങൾ ഉപയോഗിച്ച് മാറ്റിസ്ഥാപിക്കുക, കീ പ്ലേസ്‌ഹോൾഡർ നിങ്ങളുടെ ഡാഷ്‌ബോർഡിലെ ഒരു കീ ഉപയോഗിച്ചും മാറ്റിസ്ഥാപിക്കുക.

curl -X GET https://api.zinndigital.com/v1/branding \
  -H "Authorization: Bearer zdk_live_…"

സൈൻ ഇൻ ചെയ്തിട്ടുണ്ടോ? നിങ്ങളുടെ ഡാഷ്‌ബോർഡിലെ API കൺസോൾ നിങ്ങളുടെ യഥാർത്ഥ ഓർഗനൈസേഷൻ ഐഡിയും നിങ്ങളുടെ സ്വന്തം കീയും പൂരിപ്പിക്കുകയും, യഥാർത്ഥ പ്രതികരണം (response) നിങ്ങൾക്ക് കാണുന്നതിനായി ലൈവ് API-ലേക്ക് അഭ്യർത്ഥന (request) പ്രവർത്തിപ്പിക്കുകയും ചെയ്യുന്നു. ഈ എൻഡ്പോയിന്റ് 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…

പ്രതികരണം

പേര്തരംആവശ്യമാണ്എന്താണിത്
namestringഅതെThe name shown in the page title, the sidebar header and the browser tab.
dashboard_urlstringഅതെ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_urlstringഅതെ
status_urlstringഅതെ
logo_urlstringഅതെEmpty when the brand has set no logo; the client then renders the name.
primary_colourstringഅതെEmpty when the brand has set no colour; the client then uses its default.
is_white_labelbooleanഅതെ`false` for Zinn®'s own identity. Lets a surface say "this is white-labelled" without comparing the name to a literal.
is_client_of_resellerbooleanഅതെ`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…
localesstring[]അതെ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_localestringഅതെThe language a new account under this brand starts in. Always a member of `locales`.
locales_restrictedbooleanഅതെ`true` when a reseller narrowed the list, so a surface can explain why a language is missing instead of looking broken.
language_switcherbooleanഅതെ`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…
currenciesstring[]അതെ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_currencystringഅതെWhat a viewer under this brand is quoted in before they choose. Always a member of `currencies`.
currencies_restrictedbooleanഅതെ`true` when a reseller narrowed the list, so a surface can explain why a currency is missing instead of looking broken.
currency_switcherbooleanഅതെ`false` when the reseller has removed the currency control. Every client of that reseller is then quoted in `default_currency`.
paletteobjectഅതെ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_stackstringഅതെ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_urlstringഅതെ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_positionstringഅതെ
densitystringഅതെ
corner_radiusstringഅതെ
colour_schemestringഅതെThe scheme a first visit lands on.
favicon_urlstringഅതെ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_urlstringഅതെThe mark for transactional mail; falls back to the panel logo.
menu_itemsBrandNavLink[]അതെCustom navigation links the provider added, **already filtered** to what this reader may see.

ഈ എൻഡ്‌പോയിന്റ് നൽകാൻ കഴിയുന്ന പിഴവുകൾ

401 · 429