Skip to main content
GET
/
api
/
Interviews
/
{interviewId}
Retrieve a single Interview.
curl --request GET \
  --url https://api.example.com/api/Interviews/{interviewId}
{
  "id": 123,
  "typeId": 123,
  "typeName": "<string>",
  "externalReferencePrimary": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalReferenceSecondary": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sequenceID": 123,
  "date": "2023-11-07T05:31:56Z",
  "dateInLocalTimeZone": "2023-11-07T05:31:56Z",
  "duration": 123,
  "location": "<string>",
  "locationTypeID": 123,
  "subject": "<string>",
  "messageCandidate": "<string>",
  "messageClient": "<string>",
  "organizerID": 123,
  "organizerName": "<string>",
  "numberOfAttendees": 123,
  "attendeesData": [
    {
      "entityId": 123,
      "playerId": 123,
      "name": "<string>"
    }
  ],
  "clientsData": [
    {
      "entityId": 123,
      "playerId": 123,
      "name": "<string>"
    }
  ],
  "agencyID": 123,
  "createdByID": 123,
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "updatedByID": 123,
  "statusID": 123,
  "statusName": "<string>",
  "jobID": 123,
  "timeZoneName": "<string>",
  "clientEmailBody": "<string>",
  "candidateEmailBody": "<string>",
  "distributionModeCandidate": 123,
  "distributionModeClient": 123,
  "byPassTeamsLobby": true,
  "webConferenceUrl": "<string>",
  "webConferenceExternalID": "<string>",
  "clientConsultantFeedbackActivityID": 123,
  "candidateFeedbackActivityID": 123,
  "clientConsultantFeedback": "<string>",
  "candidateFeedback": "<string>",
  "candidateId": 123,
  "candidateName": "<string>",
  "jobTitle": "<string>",
  "statisticsCounts": [
    {
      "type": "<string>",
      "value": 123
    }
  ],
  "statisticsDates": [
    {
      "type": "<string>",
      "value": "2023-11-07T05:31:56Z"
    }
  ]
}

Path Parameters

interviewId
integer<int32>
required

Query Parameters

replacePlaceholders
boolean
default:true

Response

200 - application/json

OK

id
integer<int32>
typeId
integer<int32>
typeName
string | null
externalReferencePrimary
string<uuid>
externalReferenceSecondary
string<uuid>
sequenceID
integer<int32>
date
string<date-time>
dateInLocalTimeZone
string<date-time>
duration
integer<int32>
location
string | null
locationTypeID
integer<int32>
subject
string | null
messageCandidate
string | null
messageClient
string | null
organizerID
integer<int32>
organizerName
string | null
numberOfAttendees
integer<int32>
attendeesData
object[] | null
clientsData
object[] | null
agencyID
integer<int32>
createdByID
integer<int32>
dateCreated
string<date-time>
dateUpdated
string<date-time>
updatedByID
integer<int32>
statusID
integer<int32>
statusName
string | null
jobID
integer<int32>
timeZoneName
string | null
clientEmailBody
string | null
candidateEmailBody
string | null
distributionModeCandidate
integer<int32>
distributionModeClient
integer<int32>
byPassTeamsLobby
boolean
webConferenceUrl
string | null
webConferenceExternalID
string | null
clientConsultantFeedbackActivityID
integer<int32> | null
candidateFeedbackActivityID
integer<int32> | null
clientConsultantFeedback
string | null
candidateFeedback
string | null
candidateId
integer<int32> | null
candidateName
string | null
jobTitle
string | null
statisticsCounts
object[] | null
statisticsDates
object[] | null