Skip to main content
GET
Get a template

Authorizations

Authorization
string
header
required

API tokens are passed as Bearer tokens.

Path Parameters

templateId
string
required

a template ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:tpl_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Example:

"tpl_a1b2c3d4e5f64789a1b2c3d4e5f64789"

Response

Success

id
string
required

Canonical template ID (tpl_ followed by 32 lowercase hexadecimal UUID characters).

Pattern: ^tpl_[0-9a-f]{32}$
Example:

"tpl_a1b2c3d4e5f64789a1b2c3d4e5f64789"

name
string
required
type
enum<string>
required
Available options:
SCHEDULE_CONFIRMATION_CANDIDATE_EMAIL,
SCHEDULE_CONFIRMATION_CANDIDATE_CALENDAR_INVITE,
SCHEDULE_CONFIRMATION_INTERVIEWER_CALENDAR_INVITE,
SCHEDULE_CONFIRMATION_INTERNAL_CHAT_MESSAGE,
DEBRIEF_CONFIRMATION_ATTENDEE_CALENDAR_INVITE,
DEBRIEF_CONFIRMATION_INTERNAL_CHAT_MESSAGE,
CANDIDATE_AVAILABILITY_REQUEST_CANDIDATE_EMAIL,
CANDIDATE_SELF_SCHEDULE_REQUEST_CANDIDATE_EMAIL,
OTHER
subject
string | null
required
body
string | null
required

Template body as HTML. Placeholder tokens such as {{CANDIDATE_FIRST_NAME}} are returned unexpanded; ModernLoop substitutes them when the template is sent. Null when the template has no body.

is_organization_default
boolean
required
created_at
string<date-time>
required

ISO 8601 timestamp. Responses are normalized to UTC with a Z suffix.

updated_at
string<date-time>
required

ISO 8601 timestamp. Responses are normalized to UTC with a Z suffix.

last_sent_at
string<date-time> | null
required

ISO 8601 timestamp. Responses are normalized to UTC with a Z suffix.

app_url
string<uri>
required

Link that opens this resource in the ModernLoop app.