Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Interview Briefing

interviewBriefing.info

Fetch the briefing data for an interview event. Returns the application, interview, per-interviewer status, and the feedback form definition id needed to render an interviewer-facing briefing or to submit feedback via applicationFeedback.submit.

By default, each interviewer in the response is returned as a userId with status flags. Pass expand: ["interviewers"] to include the full user and pool details for each interviewer. Other expansions return the application, candidate, job, interview, and feedback form definition inline.

Requires the interviewsRead permission.

post/interviewBriefing.info

Request body

interviewEventIdstring uuid required

The id of the interview event whose briefing should be returned.

expandstring[] nullable

Choose to expand the result and include additional data for related objects.

Example request

{
  "interviewEventId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the interviewBriefing.info endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "3ae2b801-19f6-41ef-ad28-214bd731948f",
    "applicationId": "9d34f544-c150-4d70-91c4-e8b0b4a72846",
    "interviewId": "ff6c7d9d-71e3-4c9c-88b1-28824980c276",
    "interviewStageId": "5a3f9c2b-71e3-4c9c-88b1-28824980c276",
    "interviewers": [
      {
        "userId": "caea4d97-331d-46b1-a8e3-6b821c2214ef",
        "isFeedbackRequired": true,
        "hasSubmittedFeedback": false,
        "trainingRole": null
      }
    ],
    "hasSubmittedFeedback": false,
    "feedbackFormDefinitionId": "9b2cb8d9-1a6b-4d4f-9c5d-69ef7b9a9f12"
  }
}