Skip to main content
GET
Get a template
Beta: this endpoint may change or be removed without notice while in beta. There is no compatibility promise until it reaches general availability.

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:
OTHER,
CANDIDATE_AVAILABILITY_REQUEST,
CANDIDATE_CONFIRMATION,
CANDIDATE_INVITE,
DEBRIEF_CALENDAR_INVITE,
INTERVIEWER_INVITE,
SLACK_CHANNEL_MESSAGE,
DEBRIEF_CONFIRMATION_CONVERSATION_MESSAGE,
DEBRIEF_UPDATE_CONFIRMATION_CONVERSATION_MESSAGE,
DEBRIEF_UPDATE_CONFIRMATION_INTERVIEWER_CALENDAR_INVITE,
SCHEDULE_CANCELLATION_CANDIDATE_EMAIL,
SCHEDULE_CANCELLATION_INTERVIEWER_EMAIL,
SCHEDULE_CANCELLATION_CONVERSATION_MESSAGE,
SCHEDULE_UPDATE_CONFIRMATION_CANDIDATE_EMAIL,
SCHEDULE_UPDATE_CONFIRMATION_CANDIDATE_INVITE,
SCHEDULE_UPDATE_CONFIRMATION_INTERVIEWER_INVITE,
SCHEDULE_UPDATE_CONFIRMATION_CONVERSATION_MESSAGE,
SELF_SCHEDULE_REQUEST_CANDIDATE_EMAIL
subject
string | null
required
is_organization_default
boolean
required
created_at
string<date-time>
required

ISO 8601 timestamp.

updated_at
string<date-time>
required

ISO 8601 timestamp.

last_sent_at
string<date-time> | null
required

ISO 8601 timestamp.