Create an interview

Creates an interview for a candidate on a job and sends the candidate an invitation with a booking link. The interview stays PENDING until the candidate books a slot. The booking link is never returned.

Name an interview template with interviewTemplateId to fill every field you omit. A sent location, scheduling or interviewers replaces the template's value whole. The template's interviewer pools apply; its rooms and fixed-date range do not.

The first interviewer organizes the interview. The invitation and confirmation use the template's emails, else the default emails.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

An interview to create. Every field the request omits is filled from interviewTemplateId when one is named; a sent location, scheduling or interviewers replaces the template's value whole.

integer
required

ID of the candidate. They need exactly one application to the job

integer
required

A job that is not archived

string
length between 1 and 256
\S

Shown to the candidate. Required unless the interview template provides it

interviewers
array of objects
length ≥ 1

The interviewers. The first organizes the interview. Each needs access to the job and a connected calendar. Required unless the interview template names interviewers

interviewers
integer
required

ID of the user, as GET /v3/users lists them

string

Email of the user

integer
15 to 600

Duration in minutes. Required unless the interview template provides it

scheduling
object
required

How the interview has its time chosen.

location
object

Where the interview takes place. Replaces the interview template's location whole. Required unless the interview template provides one.

string
length ≤ 4096

Shown to the candidate

boolean

Whether only its organizer and interviewers see it in JOIN. Defaults to the interview template's value, else false

string

An active interview template, as GET /v3/interview-templates lists them. It fills every field the request omits

integer

An active scorecard template, as GET /v3/scorecard-templates lists them. Replaces the interview template's scorecard

Headers
string

Selects a dated API revision in YYYY-MM-DD format, such as 2026-11-17. Pin this header to choose the revision explicitly; omitting it uses the server’s default. An unsupported value returns 400 unsupported_api_version. See Versions and compatibility.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json