Appearance
List interviews
GET
/api/nova/interviews/list
Lists scheduled interviews across the account, limited to the API user's team when the team's data access is restricted. segment picks the same windows as the Interviews hub: TODAY, UPCOMING (after today), AWAITING_FEEDBACK (already happened, candidate still at the interview stage and not rejected) or COMPLETED (already happened, candidate since moved to offer or placed, or rejected). from and to (dd/MM/yyyy, both required together) filter on the interview date; with a segment they narrow within it, without one they set the window. With neither, interviews from one month ago to one month ahead are returned. jobId and ownerId narrow further. TODAY and UPCOMING are sorted soonest first, everything else most recent first. Accepts page and size (size defaults to 20 and is capped at 100). Each interview includes id, title, startDate, endDate, timeZone, cancelled, telephonic, location, meetingLink, the job, the candidate, contacts, interviewers (users invited), organiser, owner, the candidate's pipeline stage (stageCode, stageName, subStateName, rejected), notes (the interview description) and meetingNotes (notes added after the interview). Returns 400 for an unknown segment, an invalid date or only one of from and to, and 401 for an invalid API key.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
from
from
Type
string
jobId
jobId
Type
string
ownerId
ownerId
Type
string
page
page
Type
integer
Format
"int32"Default
0segment
segment
Type
string
size
size
Type
integer
Format
"int32"Default
20to
to
Type
string
Responses
OK
application/json
JSON "data": [ { "additionalProperties": { } } ], "error": "string", "message": "string", "page": 0, "requestId": "string", "size": 0, "success": true, "total": 0
{
}