Site Branding Settings API

Explains how integrations can retrieve public branding display settings based on a site's domain.

When a single backend serves sites for different brands, pages shown before login need to know each site's name, images, and links. Integrations can call GET /api/branding/ through the current site's domain to retrieve its public display settings. This read endpoint does not require login.

Read and apply settings

1. Send GET /api/branding/ through the domain that serves the site. The request's Host determines the brand; a user, organization ID, or query parameter does not select it.

2. Read the display fields you need from the response. For example, use siteName for the site name, logoFullUrl for the full logo, and primaryColor for the primary color.

3. If a field is null, hide the corresponding element; do not substitute default assets from another brand. If the domain has no dedicated configuration, the service first uses the system's default brand. If there is no default brand either, every field is null.

If your integration uses a reverse proxy, make sure the Host forwarded to the API remains the domain of the site whose brand you want to display. Calling the API directly through a shared API domain returns the brand associated with that API domain or the system's default brand.

Response fields

HTTP 200 returns a JSON object with camelCase fields:

Purpose	Fields
Text	siteName, assistantName, supportEmail, poweredByText
Image URLs	faviconUrl, logoMarkUrl, logoFullUrl, logoAnimatedUrl, assistantIconUrl, ogImageUrl
Colors	primaryColor, splashBackgroundColor, splashTextColor, progressBarColor
Links	docsUrl, termsUrl, privacyUrl, loginRedirectUrl

Every field may be null. Image fields contain URLs ready for display; use the values returned by the API directly instead of constructing media paths yourself.