Get a single template (editor payload)

Loads the full editor payload for one template type: raw override regions (null = inherit), resolved effective content, catalog defaults, theme color, and current settings (enabled, delivery method, logo visibility).

Auth: Both — authentication + an email-template feature check. company_id scoped by an ownership check. Additionally, platform-owned types are forbidden (403) for any non-platform company. (Only the reachable companies differ per role, as above.)

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
company_idintegerYesMust be an existing account inside your own account tree.
typestringYesValid EmailTemplateType value.

Response{ data. } envelope. Envelope data carries nested status, data (editor state) and defaults. Region HTML fields (override.*, resolved.*, defaults.* except subject) are base64-encoded; override.* regions are null when no override is stored.

  • status (string) — success.
  • data.type (string) — the template type value.
  • data.override (object) — raw stored override, all nullable: header, body, footer, signature (base64 or null), subject_override (plain string or null), custom_html (base64 or null).
  • data.template_mode (string) — regions or html.
  • data.resolved (object) — effective rendered regions: header, body, footer, signature (base64), subject (plain).
  • data.is_enabled (bool), data.show_logo (bool), data.delivery_method (string).
  • data.customized (bool) — any content override present.
  • data.theme.primary_color (string) — partner account color.
  • defaults (object) — catalog defaults: header, body, footer, signature, custom_html (all base64) and subject (plain).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
string
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json