Email Templates

Get an email template

GET/email-templates/{id}

Returns one template by its slug. The content is left out unless you send include=content, which adds content, default_content and default_subject, and include=placeholders adds the placeholders its content can use. An unknown or malformed slug returns 404. Use GET /email-templates to find templates.

Path parameters

  • idstringRequired#

    The template slug, such as user_welcome. It is the template's id. A leading underscore is accepted and ignored.

Query parameters

  • fieldsstring#

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

  • includestring#

    Comma-separated extras to embed: content adds content, default_content and default_subject, and placeholders adds the placeholders the content can use.

Responses

200

The email template.

EmailTemplate
{
  "data": {
    "id": "string",
    "name": "string",
    "category": "string",
    "status": "default",
    "enabled": true,
    "cc_list_enabled": true,
    "assigned_internal_cc_enabled": true,
    "subject": "string",
    "layout_mode": "fragment",
    "content": "string",
    "default_content": "string",
    "default_subject": "string",
    "placeholders": [
      {
        "value": "string",
        "label": "string"
      }
    ],
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
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
404

Resource not found (error.code = not_found).

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-templates/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"