Email Templates

List email templates

GET/email-templates
email-templates:readlist_email_templatesRead-only

Lists the platform's email templates: the system templates, the custom templates and the legacy templates the organisation already had. Stored templates are tenant-wide; legacy templates carried over from the platform belong to the token's organisation and are listed, reset and deleted for it only. A list item leaves out the content; send include=content to add it with the system defaults, or include=placeholders to add the placeholders it can use. Use GET /email-templates/{id} for one template.

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, name, category, created_at or updated_at. Prefix a field with - for descending. Defaults to name. A template never stored has no created_at or updated_at and sorts last.

  • includestring#

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

  • filter[q]string#

    Templates whose slug or name contains this text, ignoring case.

  • filter[status]string#

    Only templates in this status: default (a system template with nothing stored), customised (a system template with a stored row) or custom (created through the API or the platform). Takes [in] and [not_in] with a comma-separated list.

    One of: default, customised, custom
  • filter[category]string#

    Only templates in this category, such as Custom. Takes [in] and [not_in] with a comma-separated list, and [contains].

  • filter[enabled]boolean#

    true for templates the platform sends, false for the disabled ones.

Responses

200

One page of email templates.

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": [
        {}
      ],
      "created_at": "2026-06-12T10:00:00+00:00",
      "updated_at": "2026-06-12T10:00:00+00:00"
    }
  ],
  "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-templates\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"