Indeed Interview API reference

📘
Note:
By using this API and its documentation and building an integration, you agree to the Additional API Terms and Guidelines.

Queries

findVirtualInterviewEvents

Query that lists interview events. Optionally, you can filter this query.

findVirtualInterviewEvents input object

Field	Type	Description
first	Int	Optional.
after	String	Optional.
input	FindVirtualInterviewEventsInput	Required.

findVirtualInterviewEvents return type

VirtualInterviewEventsConnection

virtualInterviewEvents

Query that lists virtual interview events, by IDs.

virtualInterviewEvents input object

Field	Type	Description
input	VirtualInterviewEventsInput	Required.

virtualInterviewEvents return type

VirtualInterviewEventsPayload

Mutations

cancelVirtualInterviewEvent

Mutation that cancels a virtual interview event.

cancelVirtualInterviewEvent input object

Field	Type	Description
input	CancelVirtualInterviewEventInput	Required.

cancelVirtualInterviewEvent return type

CancelVirtualInterviewEventPayload

createVirtualInterviewEvent

Mutation that creates a virtual interview event, which is a scheduled virtual event that includes 1, or no, interviewee, and from 1 to 49 interviewers. When you schedule an event, the API automatically adds you as an interviewer to the event.

Get the URL for the interviewee from the VirtualInterviewInterviewee return type in the interviewRecordsConnection list.

createVirtualInterviewEvent input object

Field	Type	Description
input	CreateVirtualInterviewEventInput	Required.

createVirtualInterviewEvent return type

CreateVirtualInterviewEventPayload

updateVirtualInterviewEvent

Mutation that updates the details of a virtual interview event.

updateVirtualInterviewEvent input object

Field	Type	Description
input	UpdateVirtualInterviewEventInput	Required.

updateVirtualInterviewEvent return type

UpdateVirtualInterviewEventPayload

Input objects

AddVirtualInterviewEventIntervieweeInput

Input object to add an interviewee to an event.

Child of UpdateVirtualInterviewEventInput.

Field	Type	Description
id	ID	Required. ID of the `VirtualInterviewEvent`.
interviewee	VirtualInterviewIntervieweeInput	Required. Details about the interviewee to add to the `VirtualInterviewEvent`.

CancelVirtualInterviewEventInput

Input object to cancel an event.

Field	Type	Description
id	ID	Required. ID of the `VirtualInterviewEvent` to cancel.

CreateVirtualInterviewEventInput

Input object for the createVirtualInterviewEvent mutation.

Field	Type	Description
interviewers	VirtualInterviewInterviewerInput[]	Required. One or more interviewer email addresses. Notes: When you schedule an event, the API automatically adds you as an interviewer to the event. You can add an interviewee and interviewers to an event after you schedule it. Validation error: If the total number of interviewers exceeds 49, a validation error occurs.
startTime	DateTime	Required. Interview start time, in RFC3339 format with a time zone offset.
endTime	DateTime	Required. Interview end time, in RFC3339 format with a time zone offset. Validation error: If the interview duration is greater than 24 hours, a validation error occurs. That is, if the `endTime` value minus `startTime` value is greater than 24 hours.
timezone	TimeZone	Required. Time zone for the interview, in IANA Time Zone Database format. Displays the time zone in the event for both the interviewee and interviewers. The time zone value is separate from the `startTime` and `endTime` offset.
title	String	Required. Title of the interview, which is usually the calendar event title.
interviewee	VirtualInterviewIntervieweeInput	Optional. Name and email of the interviewee. If you don’t have the name of the interviewee, omit this field. To add the interviewee to the interview event later, use the `updateVirtualInterviewEvent` mutation.
requestMetadata	VirtualInterviewRequestMetadataInput	Required. Information about the request: Partner application, which is usually an application tracking system (ATS), from which the request was sent. Employer name, if available.
languageCode	LanguageCode	Optional. Language code, in lowercase. If you provide `countryCode`, `languageCode` is required. Validation error: If you provide `countryCode` without `languageCode`, a validation error occurs. If you omit both `languageCode` and `countryCode`, the default `languageCode` value is `en` and the default `countryCode` value is `US`. If you include `languageCode` and omit `countryCode`, `languageCode` is the value you specify and `countryCode` is null.
countryCode	CountryCode	Optional. Country code, in uppercase. If you provide `countryCode`, `languageCode` is required. Validation error: If you provide `countryCode` without `languageCode`, a validation error occurs. If you omit both `languageCode` and `countryCode`, the default `languageCode` value is `en` and the default `countryCode` value is `US`. If you include `languageCode` and omit `countryCode`, `languageCode` is the value you specify and `countryCode` is null.

FindVirtualInterviewEventsInput

Input object for the findVirtualInterviewEvents query.

Field	Type	Description
startTime	VirtualInterviewEventDateTimeRangeFilterInput	Optional. Start time of the time range of the event.
endTime	VirtualInterviewEventDateTimeRangeFilterInput	Optional. End time of the time range of the event.
sort	VirtualInterviewEventSortOptionInput[]	Optional. Ordered array of sort options. A lower index takes higher priority.

RescheduleVirtualInterviewEventInput

Input object to reschedule events.

Child of UpdateVirtualInterviewEventInput.

Field	Type	Description
id	ID	Required. ID of the `VirtualInterviewEvent`.
startTime	DateTime	Required. Updated scheduled start time for the event, in RFC3339 format with a time zone offset.
endTime	DateTime	Required. Updated scheduled end time for the event, in RFC3339 format with a time zone offset.

UpdateVirtualInterviewEventInput

Input object to update an event.

Include only one of these fields in an update request. The field determines the update behavior.

Field	Type	Description
reschedule	RescheduleVirtualInterviewEventInput	Optional. Reschedules an event.
addInterviewers	UpdateVirtualInterviewEventInterviewersInput	Optional. Adds interviewers to an event.
addInterviewee	AddVirtualInterviewEventIntervieweeInput	Optional. Adds an interviewee to an event. You can only add an interviewee to an event that does not already have an interviewee.
setTitle	UpdateVirtualInterviewEventTitleInput	Optional. Changes the title of an event.
setTimezone	UpdateVirtualInterviewEventTimezoneInput	Optional. Changes the time zone of an event.

UpdateVirtualInterviewEventInterviewersInput

Input object to add interviewers to an event.

Child of UpdateVirtualInterviewEventInput.

Adding interviewers to an event is not atomic.

Field	Type	Description
id	ID	Required. ID of the `VirtualInterviewEvent`.
interviewers	VirtualInterviewInterviewerInput[]	Required. Array of one or more email addresses of the interviewers to add to the interview.

UpdateVirtualInterviewEventTimezoneInput

Input object to change the time zone for an event.

Child of UpdateVirtualInterviewEventInput.

Field	Type	Description
id	ID	Required. ID of the `VirtualInterviewEvent`.
timezone	TimeZone	Required. Time zone for the event, in IANA Time Zone Database format.

UpdateVirtualInterviewEventTitleInput

Input object to change the title of an event.

Child of UpdateVirtualInterviewEventInput.

Field	Type	Description
id	ID	Required. ID of the `VirtualInterviewEvent`.
title	String	Required. Title for the event.

VirtualInterviewEventDateTimeRangeFilterInput

Input object of time-range information to use to filter dates.

Field	Type	Description
after	DateTime	Optional.
before	DateTime	Optional.

VirtualInterviewEventSortOptionInput

Input object that defines on which field to sort and in which direction.

Field	Type	Description
field	VirtualInterviewEventSortField	Required. Field on which to sort.
order	SortDirection	Required. Direction in which to sort. Default is `ASC`.

VirtualInterviewEventsInput

Input object for the findVirtualInterviewEvents query.

Field	Type	Description
ids	ID[]	Required. Array of one or more unique identifier (UUID) values for the events for which to show details.

VirtualInterviewIntervieweeInput

Input object that contains virtual interview interviewee information.

Field	Type	Description
name	String	Required. Display name for the interviewee.
email	EmailAddress	Required. Email address of the interviewee.

VirtualInterviewInterviewerInput

Input for a Virtual Interview Interviewer

Field	Type	Description
email	EmailAddress	Required.

VirtualInterviewRequestMetadataInput

Input object of partner metadata related to the request.

Field	Type	Description
atsName	String	Required. Partner application, which is usually an applicant tracking system (ATS), from which the request was sent.
employerName	String	Optional. Employer name, if available.

Return types

CancelVirtualInterviewEventPayload

Return type for the cancelVirtualInterviewEvent mutation.

Field	Type	Description
event	VirtualInterviewEvent	Required. The canceled event.

CreateVirtualInterviewEventPayload

Return type for the createVirtualInterviewEvent mutation.

Field	Type	Description
event	VirtualInterviewEvent	Required. Created event.

EmployerJob

Return type of information about the external employer job type.

Field	Type	Description
id	ID	Required. Job identifer for the `EmployerJob` resolver.

UpdateVirtualInterviewEventPayload

Return type for the UpdateVirtualInterviewEvent mutation.

Field	Type	Description
event	VirtualInterviewEvent	Required. Updated event.

VirtualInterviewAppointmentScheduledTime

Return type of the scheduled time slots for the appointment.

Field	Type	Description
startTime	DateTime	Optional. Start time of the appointment, in RFC3339 format with a time zone offset.
endTime	DateTime	Optional. End time of the appointment, in RFC3339 format with a time zone offset.

VirtualInterviewDecision

Return type with decision detail from the interviewer.

Field	Type	Description
value	VirtualInterviewDecisionValue	Optional. Decision value from the interviewer.
noteText	String	Optional. Decision summary and notes from the interviewer.

VirtualInterviewEvent

Return type with virtual interview event information.

Field	Type	Description
id	ID	Required. Globally unique identifier for an event. Used as a cache key and re-fetches through the root `node` field.
title	String	Required. Employer-specified title of the event.
startTime	DateTime	Required. Scheduled start time for the event, in RFC3339 format with a time zone offset. This offset is separate from the `timezone` field.
endTime	DateTime	Required. Scheduled start time for the event, in RFC3339 format with a time zone offset. This offset is separate from the `timezone` field.
timezone	TimeZone	Required. Time zone for the interview, in IANA Time Zone Database format.
interviewerLobbyUrl	WebUrl	Required. Interviewer URL to the event lobby for this event.
interviewLandingPageUrl	WebUrl	Optional. Landing page that directs the interviewee and interviewers to enter the lobby. Available to only OAuth clients.
languageCode	LanguageCode	Optional. Language code of the event. An ISO 639-2 language code string. See Supported language codes, country codes, and locales.
countryCode	CountryCode	Optional. The country code of the event. An ISO 3166-1 - alpha 2 country code string. Supported language codes, country codes, and locales.
status	VirtualInterviewEventStatus	Required. Current status of the event.
mediaType	VirtualInterviewMediaType	Required. Interview type for the event.
interviewersConnection	VirtualInterviewInterviewersConnection	Required. List of interviewers invited to this event.
intervieweesConnection	VirtualInterviewIntervieweesConnection	Required. List of interviewees invited to this event.

VirtualInterviewEventEdge

Return type of edge information for VirtualInterviewEvent pagination.

Field	Type	Description
node	VirtualInterviewEvent	Required. Event item.
cursor	String	Required. Cursor position of the node.

VirtualInterviewEventsConnection

Return type for VirtualInterviewEvent or VirtualInterviewEvents that contains pagination information.

Field	Type	Description
edges	VirtualInterviewEventEdge[]	Required. Edges for pagination.
pageInfo	PageInfo	Required. Page information for pagination. Defined in `com.indeed.graphql.relay.PageInfo`.
events	VirtualInterviewEvent[]	Required. The events for this page.
totalCount	Int	Required. Total number of events that match filter criteria, ignoring pagination.

VirtualInterviewEventsPayload

Return type for the virtualInterviewEvents query.

Note: When the API cannot find the input IDs, it returns null values.

Field	Type	Description
events	VirtualInterviewEvent[]	Required. List of events.

VirtualInterviewInterviewee

Return type with interviewee information for an event.

Field	Type	Description
id	ID	Required. Globally unique identifier (UUID) for the interviewee. Used as a cache key and re-fetches through the root `node` field.
name	String	Required. Name of the interviewee.
email	EmailAddress	Optional. Email address of the interviewee.
intervieweeLobbyUrl	WebUrl	Required. URL that the interviewee uses to join the event.
job	VirtualInterviewJob	Optional. Information about the job for which the interviewee is interviewing.
status	VirtualInterviewIntervieweeStatus	Optional. Status of the interviewee.
interviewRecordsConnection	VirtualInterviewRecordsConnection	Required. List of interview records for the interviewee.
scheduledTime	VirtualInterviewAppointmentScheduledTime	Optional. The scheduled time for the event.

VirtualInterviewIntervieweeEdge

Return type of edge information for VirtualInterviewInterviewees pagination.

Field	Type	Description
node	VirtualInterviewInterviewee	Required. Interviewee item.
cursor	String	Required. Cursor position of the node.

VirtualInterviewIntervieweesConnection

Return type for VirtualInterviewInterviewees that contains pagination information.

Field	Type	Description
edges	VirtualInterviewIntervieweeEdge[]	Required. Edges for pagination.
pageInfo	PageInfo	Required. Page info for pagination. Defined in `com.indeed.graphql.relay`.
interviewees	VirtualInterviewInterviewee[]	Required. List of interviewees for this page.
totalCount	Int	Required. Total result count, ignoring pagination.

VirtualInterviewInterviewer

Return type with interviewer information for a virtual interviewer event.

Field	Type	Description
id	ID	Required. Global unique identifier (UUID) for the interviewer.
email	EmailAddress	Required. Email address of the interviewer.
name	String	Optional. Name of the interviewer.

VirtualInterviewInterviewerEdge

Return type with edge information for VirtualInterviewInterviewers pagination.

Field	Type	Description
node	VirtualInterviewInterviewer	Required. Interviewer item.
cursor	String	Required. Cursor position of the node.

VirtualInterviewInterviewersConnection

Return type for VirtualInterviewInterviewers that contains pagination information.

Field	Type	Description
edges	VirtualInterviewInterviewerEdge[]	Required. Edges for pagination.
pageInfo	PageInfo	Required. Page info for pagination. Defined in `com.indeed.graphql.relay.PageInfo`.
interviewers	VirtualInterviewInterviewer[]	Required. List of events for this page.
totalCount	Int	Required. Total result count, ignoring pagination.

VirtualInterviewJobInfo

Return type that contains information for a virtual interview job listing.

Field	Type	Description
title	String	Optional. Job title.
location	String	Optional. Job location.

VirtualInterviewOutcome

Return type with InterviewOutcome information for an interview record.

Field	Type	Description
interviewer	VirtualInterviewInterviewer	Required. Interviewer who created this interview outcome.
decision	VirtualInterviewDecision	Optional. Outcome decision from the interviewer.

VirtualInterviewOutcomeEdge

Return type with edge information for VirtualInterviewOutcomeRecord pagination.

Field	Type	Description
node	VirtualInterviewOutcome	Required. Outcome item.
cursor	String	Required. Cursor position of the node.

VirtualInterviewOutcomesConnection

Return type for VirtualInterviewOutcome that contains pagination information.

Field	Type	Description
edges	VirtualInterviewOutcomeEdge[]	Required. Edges for pagination.
pageInfo	PageInfo	Required. Page info for pagination. Defined in `com.indeed.graphql.relay.PageInfo`.
outcomes	VirtualInterviewOutcome[]	Required. Interview outcomes for this page.

VirtualInterviewRecord

Return type of interview record information for a virtual interview interviewee.

Field	Type	Description
id	ID	Required. Globally unique identifier for an `interviewRecord`. Used as a cache key and to refetch through the root `node` field.
startTime	DateTime	Optional. Start time for the interview record, that is, the first time both the interviewer and interviewee are in the interview room, in RFC3339 format with a time zone offset.
endTime	DateTime	Optional. End time for the interview record, in RFC3339 format with a time zone offset.
interviewOutcomesConnection	VirtualInterviewOutcomesConnection	Required. List of interview outcomes.
recordingUrl	WebUrl	Optional. URL to the recording for the interview, if available.
interviewee	VirtualInterviewInterviewee	Optional. Interviewee for the interview record.

VirtualInterviewRecordEdge

Return type of edge information for VirtualInterviewRecord pagination.

Field	Type	Description
node	VirtualInterviewRecord	Required. Interviewer item.
cursor	String	Required. Cursor position of the node.

VirtualInterviewRecordsConnection

Return type for VirtualInterviewRecord that contains pagination information.

Field	Type	Description
edges	VirtualInterviewRecordEdge[]	Required. Edges for pagination.
pageInfo	PageInfo	Required. Page information for pagination. Defined in `com.indeed.graphql.relay.PageInfo`.
records	VirtualInterviewRecord[]	Required. Events for this page.

Unions

VirtualInterviewJob

Return union type that describes the output options for job information.

VirtualInterviewJobInfo
EmployerJob

Enumerations

SortDirection

Sort direction.

ASC
DESC

VirtualInterviewDecisionValue

Interviewer's judgment about an interviewee's fitness for a job.

YES
NO
MAYBE
SKIP

VirtualInterviewEventSortField

The event fields on which you can sort.

START_TIME
END_TIME

VirtualInterviewEventStatus

Current status of the event.

SCHEDULED
STARTED
ENDED
ARCHIVED
CANCELLED

VirtualInterviewIntervieweeStatus

The status of the event.

RSVPED
CHECKED_IN
INTERVIEWING
INTERVIEWED
NOT_INTERVIEWED
REQUEUED
CANCELLED

VirtualInterviewMediaType

The media on which the event occurs.

VIDEO
PHONE

Supported language codes, country codes, and locales

Supported language codes, country codes and locales
languageCode	countryCode	locale	Description
cs		cs	Czech
cs	CZ	cs-CZ	Czech (Czech Republic)
de		de	German
de	BE	de-BE	German (Belgium)
de	CH	de-CH	German (Switzerland)
de	DE	de-DE	Standard German
en		en	English
en	AE	en-AE	English (United Arab Emirates)
en	AU	en-AU	Australian English
en	BE	en-BE	English (Belgium)
en	CA	en-CA	Canadian English
en	CH	en-CH	English (Switzerland)
en	GB	en-GB	British English
en	HK	en-HK	English (Hong Kong)
en	IE	en-IE	English (Ireland)
en	IN	en-IN	English (India)
en	MY	en-MY	English (Malaysia)
en	NZ	en-NZ	English (New Zealand)
en	PH	en-PH	English (Philippines)
en	SG	en-SG	English (Singapore)
en	US	en-US	American English
en	ZA	en-ZA	English (South Africa)
es		es	Spanish
es	ES	es-ES	Spanish (Spain)
es	MX	es-MX	Spanish (Mexico)
fr		fr	French
fr	BE	fr-BE	French (Belgium)
fr	CA	fr-CA	French (Canada)
fr	CH	fr-CH	French (Switzerland)
fr	FR	fr-FR	French (France)
it		it	Italian
fr	CH	fr-CH	Italian (Switzerland)
it	IT	it-IT	Italian (Italy)
ja		ja	Japanese
jp	JP	jp-JP	Japanese (Japan)
nl		nl	Dutch
nl	BE	nl-BE	Dutch (Belgium)
nl	NL	nl-NL	Dutch (Netherlands)
pl		pl	Polish
pl	PL	pl-PL	Polish (Poland)
pt		pt	Portuguese
sv		sv	Swedish
sv	SE	sv-SE	Swedish (Sweden)
uk		uk	Ukrainian
uk	UA	uk-UA	Ukrainian (Ukraine)
zh		zh	Chinese
zh	HK	zh-HK	Chinese (Hong Kong)
zh	SG	zh-SG	Chinese (Singapore)