Get an email template

Returns a single email template by ID.

GET /api/v2/email-templates/{template_id}

Get an email template

cURL

curl --request GET \
  --url https://api.heymilo.ai/api/v2/email-templates/{template_id} \
  --header 'X-API-KEY: <api-key>'

200

{
  "data": {
    "id": "<string>",
    "template_key": "<string>",
    "name": "<string>",
    "subject": "<string>",
    "content": "<string>",
    "created_at": 123,
    "updated_at": 123,
    "object": "email_template",
    "blackout_period": {
      "enabled": true,
      "timezone": "<string>",
      "start_hour": 123,
      "end_hour": 123
    }
  },
  "meta": {}
}

Authorizations

X-API-KEY · string · header · required

API key for authentication. Pass your key in the X-API-KEY header.

Headers

X-API-KEY · string | null

Authorization · string | null

X-Workspace-Id · string | null

Path Parameters

template_id · string · required

Response

200

application/json

Successful Response

data · EmailTemplateResponse · object · required

A single email template used for candidate communications.

Templates define the subject line and HTML body for emails sent at various stages of the interview workflow (invitations, nudges, etc.).

Show child attributes

meta · Meta · object

Optional metadata. Shape varies by endpoint.