Get a template
Template
Get a template
Returns one organization email or calendar template, including its type, content, and send metadata. The template must belong to the authenticated organization or the request returns not found.
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
API tokens are passed as Bearer tokens.
Path Parameters
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
Canonical template ID (tpl_ followed by 32 lowercase hexadecimal UUID characters).
Pattern:
^tpl_[0-9a-f]{32}$Example:
"tpl_a1b2c3d4e5f64789a1b2c3d4e5f64789"
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 ISO 8601 timestamp.
ISO 8601 timestamp.
ISO 8601 timestamp.