interview-templates

Find interview templates for job application id.

Finds interview template that suppose to be used for interview creation for job associated with provided job application id. The hiring stage and hiring step the job application is currently in are taken into account when searching for matching interview template. Returns invitations content as a part of the response.

get/interview/templates/job-applications/{applicationId}

Request

Base URL
https://api.smartrecruiters.com/interview-templates
URL
https://api.smartrecruiters.com/interview-templates/interview/templates/job-applications/{applicationId}
Auth
- OAuth 2
  Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
  Client credentials
  Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: interview_templates_read
- or API key in header x-smarttoken

Path parameters

applicationIdstring uuid required

The job application id

Response

Successfully retrieved interview templates for job application id

idstring uuid

Job interview template id

hiringStage'NEW' | 'IN_PROGRESS' | 'INTERVIEW' | 'OFFER'

Hiring stage the template applies to (corresponds to current job application hiring stage)

hiringStepstring

Hiring step the template applies to (corresponds to current job application hiring step)

jobIdstring uuid

Job id the template is associated with

interviewTemplateIdstring uuid

Identifier of the interview template that was initially used to bootstrap the job interview template

templateNamestring

Name of the associated interview template

hiringTeamRoleToInterviewersobject

List of interviewers assignable to an interview by hiring team role

hiringTeamRoleToInterviewerCountobject

Required number of interviewers for given hiring team role

durationInMinutesinteger

Duration of the interview

Format of the interview

locationstring

Location of the interview

privateInterviewboolean

Flag indicating whether the interview invitation is private

zoomHostIdstring

Identifier of the user being the zoom interview host

organizerIdstring

Identifier of the user being the zoom interview organizer

meetingHostIdstring

Identifier of the user being the interview host

Example response

{
  "id": "57db9bba-dc43-4210-abf1-7a64f550041f",
  "hiringStage": "IN_PROGRESS",
  "hiringStep": "TECHNICAL_INTERVIEW",
  "jobId": "ff28458f-b9a2-43b0-82f9-f8894544ea7b",
  "interviewTemplateId": "173b459f-16b4-481f-b1f1-d3425b3f91a4",
  "templateName": "First interview template",
  "hiringTeamRoleToInterviewers": {
    "ANY": [
      "5f7b1b3b1d7f1d0001d7f1d0",
      "5f7b1b3b1d7f1d0001d7f1d1"
    ]
  },
  "hiringTeamRoleToInterviewerCount": {
    "ANY": 1
  },
  "durationInMinutes": 60,
  "format": "PHONE",
  "location": "Tehama Street, San Francisco, CA",
  "privateInterview": true,
  "invitations": [
    {
      "email": {
        "subject": "Interview invitation",
        "content": "You have been invited for an interview"
      },
      "sms": {
        "content": "You have been invited for an interview",
        "confirmationMessage": "Thanks for the confirmation"
      },
      "whatsApp": {
        "enabled": true
      },
      "line": {
        "content": "You have been invited for an interview",
        "confirmationMessage": "Thanks for the confirmation"
      },
      "language": "en",
      "repeat": {
        "intervalInMinutes": 1440,
        "count": 2
      }
    }
  ],
  "reminders": [
    {
      "message": {
        "subject": "Upcoming interview reminder",
        "content": "Hello, we would like to remind you about upcoming interview."
      },
      "language": "en"
    }
  ],
  "zoomHostId": "5f7b1b3b1d7f1d0001d7f1d0",
  "organizerId": "5f7b1b3b1d7f1d0001d7f1d0",
  "meetingHostId": "5f7b1b3b1d7f1d0001d7f1d0"
}

Changes

No recorded changes to this operation across all 1 revision of this API.