Email Themes

List email themes

GET/email-themes
email-templates:readlist_email_themesRead-only

Lists the platform's email themes, each with its id, name and default accent colour. Themes are a fixed catalogue shared by every organisation, so the list is read-only, and a theme carries no created_at or updated_at. Use GET /email-themes/{id} for one theme and GET /settings/email-theme for the theme in use.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • sortstring#

    Comma-separated fields to sort by: id or name. Prefix a field with - for descending. Defaults to id.

  • filter[q]string#

    Themes whose id or name contains this text, ignoring case.

Responses

200

One page of email themes.

EmailTheme[]
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "default_accent": "string"
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/email-themes\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"