Britive platform release 2026.09.02 is now live in production.

Get applied branding

Prev Next
Get
/api/settings/branding

Returns the currently applied (published) branding — brand text, logo URLs, favicon URL, right-side panel config, and hideBuiltInThemes flag. No authentication required; called by the login page before the user authenticates.

Security
HTTP
Type bearer
Responses
200

Applied branding, or empty object if branding has never been applied

Expand All
object
brandText
string

Tenant brand/welcome text.

hideBuiltInThemes
boolean

Whether the tenant's built-in themes are hidden.

isApplied
boolean

Whether this is the currently applied (published) branding.

isDark
boolean

Whether the tenant default theme is dark mode. Derived from pab_tenant_theme; not stored on the branding record.

lightLogoUrl
string

Cache-busting serve URL for the light logo. Null if not uploaded.

darkLogoUrl
string

Cache-busting serve URL for the dark logo. Falls back to lightLogoUrl if no dark logo uploaded.

faviconUrl
string

Cache-busting serve URL for the favicon. Null if not uploaded.

rightSidePanel
object (RightSidePanelDto)

Tenant-wide right-side panel configuration, independent of any individual theme.

type
string

Panel mode — default, solid color, or custom image.

Valid values[ "BRITIVE_DEFAULT", "SOLID_COLOR", "IMAGE" ]
Default"BRITIVE_DEFAULT"
color
string

HEX color code. Required when type is SOLID_COLOR. Null/omitted otherwise.

imageUrl
string

Cache-busting serve URL for the panel image. Not mode-dependent (single image, unlike the logo). Null unless type is IMAGE.