Skip to main content
GET
/
studies
/
{studyId}
/
interviews
/
{interviewBookingId}
Get an interview by ID
curl --request GET \
  --url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/interviews/{interviewBookingId} \
  --header 'Authorization: Bearer <token>'
{
  "interviewBookingId": "<string>",
  "studyId": "<string>",
  "state": "SCHEDULED",
  "startTime": "2023-11-07T05:31:56Z",
  "endTime": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "title": "<string>",
  "description": "<string>",
  "conferenceType": "NONE",
  "observerRoomId": "<string>",
  "participants": [
    {
      "email": "<string>",
      "rsvpStatus": "NOREPLY",
      "type": "PARTICIPANT",
      "participantId": "<string>"
    }
  ],
  "hosts": [
    {
      "email": "<string>",
      "rsvpStatus": "NOREPLY",
      "type": "HOST",
      "userId": "<string>"
    }
  ],
  "guests": [
    {
      "email": "<string>",
      "rsvpStatus": "NOREPLY",
      "type": "GUEST",
      "userId": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

studyId
string
required
interviewBookingId
string
required

Response

The interview

interviewBookingId
string
required

The ID of the interview

studyId
string
required

The ID of the study

state
enum<string>
required
Available options:
SCHEDULED,
CANCELED,
COMPLETED,
NO_SHOWED
startTime
string<date-time> | null
required
endTime
string<date-time> | null
required
timezone
string | null
required
title
string | null
required
description
string | null
required
conferenceType
enum<string> | null
required
Available options:
NONE,
ZOOM,
GOOGLE_MEET,
CALENDLY,
CUSTOM,
MICROSOFT_TEAMS
observerRoomId
string | null
required
participants
object[]
required
hosts
object[]
required
guests
object[]
required