Documentation
Sign inGet started

Get an email template

GET
/v1/email/templates/{template_id}
curl -X GET "https://us1.platform.bird.com/v1/email/templates/{template_id}" \
  -H "Authorization: Bearer $TOKEN"
Returns a single email template with its current draft content (subject, HTML, and plain text), the draft revision, and its draft and published version ids.
Contenu de la réponse
id
string
obligatoire
Template ID.
workspace_id
string
obligatoire
Workspace that owns the template.
name
string
obligatoire
Human-readable template name, unique within the workspace.
alias
nullable string
The template's workspace-unique slug handle for send-by-template, or null if unset.
description
nullable string
Optional description of the template's purpose. Null when unset.
category
string
obligatoire
Whether the template is transactional or marketing email.
source
string
obligatoire
The authoring format the template is written in. Fixed at creation.
draft_version_id
string
obligatoire
The current editable draft version.
published_version_id
nullable string
The currently published version, or null if the template has never been published.
revision
integer
obligatoire
The draft's revision counter. Send it back on the next update to detect concurrent edits.
subject
nullable string
The draft's email subject line. Null when unset.
html
nullable string
The draft's HTML body. Null when unset.
text
nullable string
The draft's plain-text body. Null when unset.
brand_kit_id
nullable string
The brand kit applied to the draft, or null if none.
created_at
string
obligatoire
When the template was created.
updated_at
string
obligatoire
When the template was last modified.