Skip to main content
GET
/
templates
/
{slug}
/
merge-tags
Get Template Merge Tags
curl --request GET \
  --url https://app.lettr.com/api/templates/{slug}/merge-tags \
  --header 'Authorization: Bearer <token>'
{
  "message": "Merge tags retrieved successfully.",
  "data": {
    "template_slug": "welcome-email",
    "version": 2,
    "merge_tags": [
      {
        "key": "first_name",
        "required": true
      },
      {
        "key": "company_name",
        "required": false
      },
      {
        "key": "order_items",
        "required": false,
        "children": [
          {
            "key": "item_name",
            "type": "text"
          },
          {
            "key": "item_quantity",
            "type": "number"
          },
          {
            "key": "item_price",
            "type": "number"
          }
        ]
      }
    ]
  }
}
Returns the merge tags found in a template’s content. Use this to discover which substitution_data keys a template expects when sending an email. By default, merge tags are extracted from the active version. Use the version query parameter to inspect a specific version instead.

Authorizations

​
Authorization
string
header
required

API key for authentication

Path Parameters

​
slug
string
required

The template slug (URL-friendly identifier)

Example:

"welcome-email"

Query Parameters

​
project_id
integer

Project ID to retrieve the template from. If not provided, uses the team's default project.

Required range: x >= 1
​
version
integer

Template version number. If not provided, uses the active version.

Required range: x >= 1

Response

Merge tags retrieved successfully

Response containing merge tags for a template version

​
message
string
required

Human-readable response message

Example:

"Merge tags retrieved successfully."

​
data
object
required

Merge tags for a template version