Read email-template settings
GET /email-templates
Returns the registered email templates and their overrides.
You need system.config.read, system.config.write or system.admin for the whole install; a permission held only for a team doesn’t count. Without one you get 403, and signed-out callers get 401. Override rows are read directly from the database, not from the rendering cache.
Every registered template is listed, even when no overrides are saved. Names are in alphabetical order, and each template lists its parts in subject, text, html order, with HTML only when the template ships one. This build has six templates: admin_test, notification_digest, notification_generic, notification_saved_search_digest, notification_saved_search_removed_digest and register_verify.
Each part includes its shipped source and an overridden flag. A saved override adds its body and update timestamp. The flag means a row exists, not that a particular email will use it: rendering has its own cache and can fall back to the shipped source. Rows for names or parts that aren’t in the shipped registry are left out.
The field catalogue documents the scalar values and repeated groups used to build validation samples. It’s guidance for template authors, not a static check of every template branch or a runtime filter on the data each sender supplies. Previewing or saving an override doesn’t send mail or show that the related delivery path is enabled. Templates have no per-language overrides here.
Authorizations
Section titled “Authorizations ”Responses
Section titled “ Responses ”The registered template catalogue, with shipped parts, saved overrides and documented sample fields.
Registered email templates, their shipped source parts, saved overrides and documented validation fields. This is a configuration catalogue, not a delivery report.
object
Every registered template in alphabetical order, including those with no saved override. This build has six, and each currently ships subject, text and HTML parts.
One registered email template and its authoring information.
object
The stable, case-sensitive registered template name, such as admin_test.
Example
admin_testThe catalogue’s description of what the template is for. It doesn’t confirm that an email was or will be sent.
Shipped parts in subject, text, html order; HTML is left out when the template has none. Each part reports its own saved override.
One source part of a registered template. Its saved state can differ from the rendering cache.
object
The source part: subject, text or html.
The source bundled with the application for this part, as template text, not a rendered email.
True when a saved override row was found for this registered part. That doesn’t guarantee a render uses it: caches or render-time fallback can pick other source.
The saved override source, present only when a matching row exists. It hasn’t been rendered with recipient data.
The saved override’s update timestamp, when available. Left out when there’s no override.
The documented fields used to build this event’s validation sample. Validation runs that sample; it doesn’t statically inspect every branch or restrict every runtime data map.
object
Documented scalar fields. In the sample, strings are placeholders and numbers are 2.
One documented scalar field for the event or a row in a repeated group.
object
The case-sensitive field name used in a template expression, for example site_name.
Example
site_nameThe documented scalar kind: string or number. It describes the field; it doesn’t validate sender data at runtime.
The catalogue’s explanation of this field for template authors.
Documented repeated groups. The validation sample gives each group one populated row; a real render can have zero, one or several.
A documented repeated group whose rows expose their own scalar fields.
object
The case-sensitive group name used in a range expression, for example hits.
Example
hitsThe catalogue’s explanation of the group and its intended use.
The documented scalar fields in each row of this group. The validation sample fills in all of them in its one row.
One documented scalar field for the event or a row in a repeated group.
object
The case-sensitive field name used in a template expression, for example site_name.
Example
site_nameThe documented scalar kind: string or number. It describes the field; it doesn’t validate sender data at runtime.
The catalogue’s explanation of this field for template authors.
Authentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}Authenticated but missing required capabilities
object
Human-readable error summary
Example
the request could not be completed