Skip to main content
post/applications/{id}/interviews
Request example
Response
post/applications/{id}/interviews

Authorization

x-api-keystringheaderrequired#
The API key to authenticate requests.

2 alternative authorization methods available — see the spec for details.

Path parameters

idstringrequired#

Body

application/json
kindenum<string>required#
Options:screeningtechnicalbehavioralonsiteother
durationMinutesinteger#

Default: 60

Range: 5–1440

locationstring#

Default: ""

Length: max 500

notesstring#

Default: ""

Length: max 5000

participantsobject[]#

Default: []

Items: max 20

audienceenum<string>#

Default: "other"

Options:recruiterhiring-managerpractitionerpanelother
timezonestring#

Default: "UTC"

Length: 1–100

atstringrequired#
Scheduled start, as an ISO 8601 date-time.

Responses

application/json
The updated application.
idstringrequired#
The ID of the application.
companystringrequired#
The company applied to.

Length: min 1

rolestringrequired#
The role / job title.

Length: min 1

locationstring · nullrequired#
salarystring · nullrequired#
statusenum<string>required#
The current pipeline stage. closed ends it, with a reason.
Options:savedappliedscreeninginterviewofferclosed
laneIdstring · null#
The owner-defined pipeline lane, when supported.
closedReasonenum<string> · nullrequired#
Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response.
resumeIdstring · nullrequired#
The linked Reactive Resume, if any.
coverLetterIdstring · nullrequired#
The linked saved cover letter, if any.
sentResumeVersionIdstring · nullrequired#
The version of the linked resume saved when the application was sent (reached Applied).
sentCheckScoreinteger · nullrequired#
The resume's Check score when it was sent, out of 100.
sentCoverLetterVersionIdstring · nullrequired#
The version of the linked letter saved when the application was sent.
sourcestring · nullrequired#
tagsstring[]required#
sourceUrlstring · nullrequired#
jobDescriptionstring · nullrequired#
postingSourceobject · nullrequired#
requirementsstring[]required#
What the posting asks for, as read when the application was added.
matchScoreinteger · nullrequired#
aiMetadataobject · nullrequired#
notesstring · nullrequired#
resumeFileUrlstring · nullrequired#
resumeFileNamestring · nullrequired#
coverLetterUrlstring · nullrequired#
coverLetterNamestring · nullrequired#
followUpAtstring · nullrequired#
followUpNotestring · nullrequired#
contactsobject[]required#
activityobject[]required#
appliedAtstringrequired#
createdAtstringrequired#
updatedAtstringrequired#