Get email branding

GET

/clusters/{cluster_id}/realms/{realm}/branding/email

curl --request GET \
  --url http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/realms/customer-portal/branding/email \
  --header 'API-Key: <API-Key>' \
  --header 'API-Version: 2026-06-01.beta'

• Local development

Returns the email template branding configuration for a realm. Returns 404 if no branding has been configured.

Required scope: branding:read

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

cluster_id

required

string format: uuid

realm

required

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

string

>= 1 characters <= 63 characters /^[a-zA-Z][a-zA-Z0-9-]*$/

Example

customer-portal

Header Parameters

API-Version

required

string

Allowed values: 2026-06-01.beta

Responses

200

The request has succeeded.

Media typeapplication/json

Email template branding configuration for a Keycloak realm.

object

cluster_id

required

string format: uuid

realm

required

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

string

>= 1 characters <= 63 characters /^[a-zA-Z][a-zA-Z0-9-]*$/

primary_color

Primary accent color used in email templates.

string

header_logo_light_url

Logo URL for light-background email clients.

string format: uri

header_logo_dark_url

Logo URL for dark-background email clients.

string format: uri

company_url

URL of the company website linked from the email footer.

string format: uri

footer_company_name

string

<= 100 characters

footer_text

string

<= 500 characters

show_powered_by

Display a ‘Powered by Skycloak’ line in the email footer.

boolean

internationalization

Internationalization settings.

object

enabled

required

boolean

default_locale

required

IETF BCP 47 language tag used as the default locale.

string

>= 2 characters <= 20 characters

supported_locales

required

Locales available to users. Must include default_locale.

Array<string>

>= 1 items

status

required

string

Allowed values: applying applied failed

applied_at

Timestamp of the most recent successful deployment to Keycloak.

string format: date-time

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "realm": "customer-portal",
  "primary_color": "#1a73e8",
  "status": "applying"
}

401

Access is unauthorized.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string format: uri

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

403

Access is forbidden.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string format: uri

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

404

The server cannot find the requested resource.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string format: uri

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

429

Client error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string format: uri

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

Headers

Retry-After

integer

RateLimit-Limit

integer

RateLimit-Remaining

integer

RateLimit-Reset

integer

X-RateLimit-Limit-Second

integer

X-RateLimit-Remaining-Second

integer

X-RateLimit-Limit-Minute

integer

X-RateLimit-Remaining-Minute

integer

X-RateLimit-Limit-Hour

integer

X-RateLimit-Remaining-Hour

integer

X-RateLimit-Limit-Day

integer

X-RateLimit-Remaining-Day

integer

500

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string format: uri

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

501

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string format: uri

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}