Studies

Get an interview by ID

Get an interview by ID

get/studies/{studyId}/interviews/{interviewBookingId}

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/studies/{studyId}/interviews/{interviewBookingId}
  • Auth: HTTP bearer

Path parameters

studyIdstring required
interviewBookingIdstring required

Response

The interview

interviewBookingIdstring required

The ID of the interview

studyIdstring required

The ID of the study

state'SCHEDULED' | 'CANCELED' | 'COMPLETED' | 'NO_SHOWED' required
role'PRIMARY' | 'STANDBY' required

PRIMARY holds the slot. STANDBY is a backup seat on the same slot as another interview (its primary), not an additional interview: the standby participant is admitted only if the primary does not show. Counting interviews for a study should count PRIMARY rows only.

waitingRoomStatus'WAITING' | 'ADMITTED' | 'JOINED' | 'RELEASED' | 'null' nullable required

Where this participant stands in the session's waiting room, on studies that use one: WAITING until the host acts, ADMITTED once let in, JOINED once they took the seat, RELEASED when the other seat on the slot took it. Null on studies without a waiting room.

startTimestring date-time nullable required
endTimestring date-time nullable required
timezonestring nullable required
titlestring nullable required
descriptionstring nullable required
conferenceType'NONE' | 'ZOOM' | 'GOOGLE_MEET' | 'CALENDLY' | 'CUSTOM' | 'MICROSOFT_TEAMS' | 'null' nullable required
conferenceUrlstring nullable required

The URL of the conference/meeting

observerRoomIdstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.