Retrieve a template | Nexiom Connect

GET/v1/emails/templates/{templateId}

Authorization

Bearer token

Authorizationrequiredheader: Send your API key as Bearer YOUR_API_KEY.
Permissionemail.full_access

Path parameters

templateIdrequiredstring: The template ID, as used in templateId when sending.

Response

application/json200 OK

idstring: Template ID.
namestring: Display name.
aliasstring: Template alias.
descriptionstring or null: Optional description.
categorystring or null: Optional category.
originstring: One of"custom""prebuilt"
published_version_idstring or null: The version sends use.
draft_version_idstring or null: The unpublished draft, if any.
archived_atstring or null: When the template was archived. Archived templates cannot be sent.
usage_countnumber: How many sends used the template.
last_used_atstring or null: When a send last used the template.
published_versionobject or null: The full published version.
draft_versionobject or null: The full draft version.

Each version has version_number, status, subject, html, text, preview_text, published_at, and variables. published_version.variables lists exactly the variables a send uses. A version's content is the dashboard editor's document; build on html and text instead.

curl "https://api-connect.nxiom.com/api/v1/emails/templates/YOUR_TEMPLATE_ID" \
  -H "Authorization: Bearer $NEXIOM_API_KEY"

Set NEXIOM_API_KEY in your environment.

{
  "message": "Email template details fetched",
  "data": {
    "id": "template_example",
    "organization_id": "organization_example",
    "project_id": "project_example",
    "name": "Welcome",
    "alias": "welcome",
    "description": null,
    "category": null,
    "origin": "custom",
    "locale": "en",
    "draft_version_id": null,
    "published_version_id": "version_example",
    "archived_at": null,
    "usage_count": 12,
    "last_used_at": "2026-10-03T09:00:00.000Z",
    "created_at": "2026-09-20T09:00:00.000Z",
    "updated_at": "2026-09-21T09:00:00.000Z",
    "draft_version": null,
    "published_version": {
      "id": "version_example",
      "template_id": "template_example",
      "version_number": 2,
      "status": "published",
      "subject": "Welcome, {{first_name}}",
      "preview_text": null,
      "from_name": null,
      "from_address": null,
      "reply_to": null,
      "content": {},
      "html": "<p>Hi {{first_name}}</p>",
      "text": "Hi {{first_name}}",
      "thumbnail_url": null,
      "editor_revision": 4,
      "created_by_customer_id": null,
      "published_by_customer_id": null,
      "published_at": "2026-09-21T09:00:00.000Z",
      "created_at": "2026-09-21T08:00:00.000Z",
      "updated_at": "2026-09-21T09:00:00.000Z",
      "variables": [
        {
          "id": "variable_example",
          "key": "first_name",
          "type": "string",
          "required": true,
          "fallback_value": null
        }
      ]
    }
  }
}

Example successful response.

Authorization#

Path parameters#

Response#

Authorization

Path parameters

Response