Interviews

This is an object representing your interview scheduled in SmartRecruiters. An interview consists of details and notes that inform participants the purpose of the meeting. as well as the location and channel where the interview will be conducted. The Interview API allows you to create interviews and retrieve and update these interviews that you created.

🚧

Interviews Created in SmartRecruiters

The Interview API only allows you to retrieve interview objects that were created by the Interview APIs and does not provide the capability for you to retrieve interviews created in SmartRecruiters or other sources.

{
  "id": "string",
  "candidate": {
    "id": "string",
    "status": "accepted"
  },
  "jobId": "string",
  "location": "string",
  "organizerId": "string",
  "timezone": "string",
  "timeslots": [
    {
      "id": "string",
      "interviewType": "string",
      "title": "string",
      "place": "string",
      "startsOn": "2021-07-26T18:49:09.192Z",
      "endsOn": "2021-07-26T18:49:09.192Z",
      "interviewers": [
        {
          "id": "string",
          "status": "accepted"
        }
      ]
    }
  ],
  "createdOn": "2021-07-26T18:49:09.192Z",
  "refUrl": "string"
}

The interview object

id string
Unique interview identifier

candidate object
The candidate who is invited to the interview

  • candidate.id string
    Unique candidate identifier
  • candidate.status string
    The interview acceptance status of the candidate. Possible values: accepted, declined, pendingandtentative`

jobId string
Unique job identifier

location string
The location of the interview. This can be a physical address or a virtual meeting room link.

*organizerId string
Unique user identifier of the user who scheduled the interview

timezone string
The name of the time zone. Possible values are the TZ database names described in the TZ database

timeslots array of objects
Time blocks when the interview event occurs. An interview events can contain more than one time blocks.

  • timeslots.id string
    Unique interview time slot identifier
  • **timeslots.interviewType string
    The type of interview of the time slot
  • timeslots.title string
    The title of the interview event of the time slot
  • timeslots.place string
    A more specific description on the meeting location (e.g. Conference Room 100)
  • timeslots.startsOn date-time
    The time when the interview event of the time slot begins. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.
  • timeslots.endsOn date-time
    The time when the interview event of the time slot ends. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.
  • timeslots.interviewers object
    Panel of interviewers who are conducting the interview of the time slot
    • timeslots.interviewers.id id
      Unique user identifier of the user who is invited to attend the interview
    • timeslots.interviewers.status string
      The interview acceptance status of the user. Possible values: accepted, declined, pending and tentative

createdOn date-time
The time when the interview event was created. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.

refUrl string