Get branding configuration

GET

/api/branding

curl --request GET \
  --url https://example.com/api/branding

Unauthenticated endpoint that returns optional branding for the login page and web UI. All fields are optional; empty values mean no branding is configured. Returns an empty object if no branding is configured.

Responses

200

Branding configuration (may be empty)

Media typeapplication/json

object

data

required

object

login_notice

LoginNotice is a plain-text message shown on the login page before authentication. Empty disables the notice. Supports newlines for multi-line text.

string

logo_url

LogoURL is generated by the server and points to /api/branding/logo when a logo is configured. Always same-origin, never an external URL. Omitted entirely when no logo is configured (not set to empty string).

string

org_name

OrgName is the organization name displayed in the web UI (e.g., “Acme Corp”). Empty disables organization-specific branding.

string

support_email

SupportEmail is the deployment’s own support address, validated at startup. When set, the login page’s “contact your administrator” and the footer’s issue link both become mailto: links to it; when unset, both keep their defaults. Omitted entirely when unconfigured.

string

support_label

SupportLabel is the link text for SupportEmail. Omitted when unset, and the client falls back to showing the address itself.

string

error

string

Example ^generated

{
  "data": {
    "login_notice": "example",
    "logo_url": "example",
    "org_name": "example",
    "support_email": "example",
    "support_label": "example"
  },
  "error": "example"
}