Theme switcher

Interviews

Header Parameters

Content-Typestring
Authorizationstring

Query Parameters

limitinteger

Number of interviews to return per page. Must be between 5 and 50

sortBystring

Determines the sorting direction, where desc applies descending order and asc applies ascending order; defaults to descending if not specified (e.g., sortBy=id&sortOrder=asc).

sortOrderstring

Specifies the field used to sort results; accepts only supported fields per endpoint and defaults to a predefined field if not provided (e.g., sortBy=id&sortOrder=asc). Supports sorting by id, modified, created; defaults to descending order on id.

jobSeekerIdstring

Filters interviews by applicant ID. These IDs can be retrieved from the getApplicantsList endpoint.

jobIdstring

Filters interviews by job ID. These IDs can be retrieved from the getJobPostingsList endpoint.

submissionIdstring

Filters interviews by submission ID. These IDs can be retrieved from the getSubmissionsList endpoint.

createdBystring

Filters interviews by user ID. These IDs can be retrieved from the getUsersList endpoint.

modifiedBystring

Filters interviews by user ID. These IDs can be retrieved from the getUsersList endpoint.

businessUnitIdstring

Filters interviews by business unit IDs. These IDs can be retrieved from the getBusinessUnitsList endpoint.

fromDatestring

Start date for interview date range filtering

toDatestring

End date for interview date range filtering

filterstring

Specifies whether to filter by creation date or modification date when using fromDate/toDate

periodValinteger

Filters interviews by predefined period value. Uses system-defined date ranges

Response

200
Object

Response Attributes

idstring
business_unit_idnumber
job_idstring
interview_datestring
end_timestring
time_zonestring
interview_modestring
interview_topicobject
contact_numberstring
skype_idstring
venuestring
interview_roundstring
interview_end_clientstring
modifiedstring
createdstring
guestsstring
internal_interviewersstring
interview_outcomestring
external_interviewersstring
job_seeker_idstring
submission_idstring
created_bystring
400
Object
Invalid parameters or filters.
401
Object
Please provide the access token.
403
Object
Your company access is temporarily disabled.
404
Object
Data not found.
429
Object
Request limit exceeded. Please try again later.
Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?