v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Job Interviews

List job interviews

Job interviews are the interview slots configured on a job's interview plan — the template definitions that say, for example, "this job's Onsite stage has a 30-minute recruiter chat, a 45-minute hiring manager interview, and a take-home test." Each slot belongs to a job_interview_stage on a specific job and carries the default name, duration, scheduling type, and scorecard requirement. When a candidate reaches the stage, individual interviews are spun up from these slots and scheduled against the candidate's application — the id returned here is the job_interview_id you pass to the Create Interview endpoint. Scope the list with parent=job|job_interview_stage plus ids to pull the slots for one or more jobs or stages. summary and instructions reflect the slot's defaults at the time it was added to the job and do not stay in sync with later edits made to the interview's Interview Prep — use the Interview Kits endpoint for the live values.

get/v3/job_interviews

Query parameters

cursorstring

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

per_pageinteger

Number of results per page

idsinteger[]

Comma separated list

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
job_interview_stage_idsinteger[]

Comma separated list

job_idsinteger[]

Return only interview slots belonging to these job (hiring plan) ids. Each slot is configured on a single job's interview plan.

fieldsstring[]

Comma separated list of fields to return

activeboolean

Filter by whether the slot is on the job's current interview plan. Omit to return both active and inactive slots; pass true to restrict to the current plan or false to return only retired slots.

scheduling_type'none' | 'needs_scheduling' | 'take_home_test' | 'offer'

Filter by how the slot is fulfilled. needs_scheduling for calendared interviews, take_home_test for asynchronous tests, offer for the offer step, none for feedback-only slots.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
job_interview_stage_idinteger

Id of the job_interview_stage this slot belongs to (the section of the job's interview plan, e.g. "Onsite").

job_idinteger

Id of the job whose interview plan this slot is defined on.

sort_orderinteger

Position of this slot within its job_interview_stage, ascending. The first interview in the stage is 1.

scheduling_type'none' | 'needs_scheduling' | 'take_home_test' | 'offer' | 'null' nullable

How the slot is fulfilled when a candidate hits the stage. needs_scheduling is a calendared interview that coordinators book against candidate availability; take_home_test is an asynchronous test sent through Greenhouse; offer is the offer step; none is a feedback-only slot (no scheduling). null for legacy steps with no scheduling type set.

durationinteger nullable

Default length of the interview in minutes, used to seed the scheduler. null if not set on the slot.

summarystring nullable

Candidate-facing summary copied from the interview's default Interview Prep when the slot was added to the job. Snapshot only — edits made later in the job's Interview Kit are not reflected here; use the Interview Kits endpoint for the live value.

instructionsstring nullable

Interviewer-facing instructions copied from the interview's default Interview Prep when the slot was added to the job. Snapshot only — edits made later in the job's Interview Kit are not reflected here; use the Interview Kits endpoint for the live value.

namestring

Name of the interview slot as it appears on the job's interview plan (e.g. "Recruiter Phone Screen", "Hiring Manager Interview").

activeboolean

Whether the slot is on the job's current interview plan. Inactive slots are retained for historical interviews that were scheduled against them but are not used for new applications.

require_scorecardboolean nullable

Whether interviewers must submit a scorecard for interviews scheduled against this slot. Only meaningful for needs_scheduling and take_home_test slots; null for none and offer slots, which never collect scorecards.