Sign in
Branding

Retrieve the acting organization's branding

Changed on

GET /branding/ — retrieve the acting org's branding.

Uses the two-condition eligibility gate (parentless, entitled) rather than the write gate; the two admit the same set -- see _check_branding_read_gate. An eligible org with no branding row yet falls through to the 404-no-row-yet / 200-with-a-row branch below.

get/branding/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Response

app_namestring required

The display name of the white-labeled app (e.g., 'MyScheduler').

logo_urlstring nullable
primary_colorstring

Primary color as hex code: #RRGGBB or #RRGGBBAA.

secondary_colorstring

Secondary color as hex code: #RRGGBB or #RRGGBBAA.

support_emailstring email

Email address for the From/reply-to on branded transactional emails.

redirect_urlstring uri

Single post-authentication redirect destination for this organization. Replaces the old return_url_allowlist: no caller-supplied redirect target is ever honored, so there is nothing to validate at request time and no open-redirect surface. Must be HTTPS with no wildcard character and no path-prefix pattern (organizations.redirect_url_validation).

Changes

  • 193c4a0f6c85Revision changes
    • ▲

      the response property became nullable for the status

  • a5fdf3d27f1aRevision changes
    • ▲

      the response property became nullable for the status

    • ▲

      the response property's maxLength was unset from 200 for the response status

    • ▲

      the response's property format changed from uri to no format for status

    • ●

      removed the optional property from the response with the status

    • ○

      added the optional property to the response with the status