Sign in

v1

latestOpenAPI 3.1.02026-07-224239180.9 KB
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/v1/templates/{templateId}

Path parameters

templateIdstring 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.

Example:tpl_a1b2c3d4e5f64789a1b2c3d4e5f64789

Response

Success

idstring required

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

namestring required
type'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' required
subjectstring nullable required
is_organization_defaultboolean required
created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

last_sent_atstring date-time nullable required

ISO 8601 timestamp.

Example response

{
  "id": "tpl_a1b2c3d4e5f64789a1b2c3d4e5f64789"
}