Docs

Get a branding revision by ID

GET
/branding/{id}

Retrieves a single branding revision, including its stored configuration.

Authorization

headerAuthorizationBearer <token>

Scope: branding.read

Path Parameters

id*string

The unique identifier of the branding revision.

Response Body

The branding revision was retrieved successfully.

application/json
  1. response

A stored branding revision. branding echoes the canonical stored configuration so clients (e.g. the CLI sync engine) can reconcile local files with the server's stored state.

id*string

The unique identifier of this branding revision.

created_at*string

When this revision was published.

Formatdate-time
branding*

Branding configuration, used in two places with one shape: as the request body of POST /branding, which publishes it as a new immutable revision, and as a read-only projection on flow responses, which carries the project's latest revision. Locally it is the .zitadel/branding/ descriptor that zitadel apply publishes.

Every field is optional. An omitted key uses Zitadel's maintained default, so a revision carrying one colour is as valid as one carrying the whole object.

Example Request
import { configureZitadel, getApi } from "@zitadel/api/config";// In the browser, through the SDK proxy: the session cookie authenticates the call.const client = getApi(configureZitadel({ projectId: "proj_01KWH1P4MYS7F0N9WD3P2E4YM5" }));const branding = await client.getBrandingById("brnd_01KWH1P4MYS7F0N9WD3P2E4YM5");
Example Response
{  "id": "string",  "created_at": "2019-08-24T14:15:22Z",  "branding": {    "$schema": "string",    "layout": "centered",    "liquid_template": "string",    "logo_url": "http://example.com",    "hero_url": "http://example.com",    "theme": {      "mode": "light",      "light": {        "logo_url": "http://example.com",        "palette": {          "primary": "#4F46E5",          "on_primary": "#4F46E5",          "background": "#4F46E5",          "surface": "#4F46E5",          "muted": "#4F46E5",          "border": "#4F46E5",          "text": "#4F46E5",          "text_muted": "#4F46E5",          "link": "#4F46E5",          "success": "#4F46E5",          "warning": "#4F46E5",          "error": "#4F46E5"        }      },      "dark": {        "logo_url": "http://example.com",        "palette": {          "primary": "#4F46E5",          "on_primary": "#4F46E5",          "background": "#4F46E5",          "surface": "#4F46E5",          "muted": "#4F46E5",          "border": "#4F46E5",          "text": "#4F46E5",          "text_muted": "#4F46E5",          "link": "#4F46E5",          "success": "#4F46E5",          "warning": "#4F46E5",          "error": "#4F46E5"        }      }    },    "typography": {      "font_family": "string",      "font_url": "http://example.com",      "scale": 0.75    },    "shape": {      "radius": "none",      "density": "compact",      "logo_scale": 0.5    }  }}

Was this helpful?