Skip to main content
GET
/
api
/
templates.get
Get a template
curl --request GET \
  --url https://{notifuseDomain}/api/templates.get \
  --header 'Authorization: Bearer <token>'
{
  "template": {
    "id": "welcome_email",
    "name": "Welcome Email",
    "version": 1,
    "channel": "email",
    "email": {
      "sender_id": "sender_123",
      "reply_to": "support@example.com",
      "subject": "Welcome, {{user_name}}!",
      "subject_preview": "Get started with your account",
      "compiled_preview": "<string>",
      "visual_editor_tree": {
        "type": "mjml",
        "children": []
      }
    },
    "web": {
      "content": {},
      "html": "<string>",
      "plain_text": "<string>"
    },
    "category": "transactional",
    "template_macro_id": "<string>",
    "integration_id": "<string>",
    "test_data": {
      "user_name": "John Doe",
      "action_url": "https://example.com/action"
    },
    "settings": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API token for authentication

Query Parameters

workspace_id
string
required

The ID of the workspace

id
string
required

The ID of the template

version
integer

Specific version number (defaults to latest)

Response

Template retrieved successfully

template
object