Skip to main content
GET
/
studies
/
{studyId}
/
interviews
Get a paginated list of interviews in a study
curl --request GET \
  --url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/interviews \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "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",
      "conferenceUrl": "<string>",
      "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>"
        }
      ]
    }
  ],
  "total": 123,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "<string>",
    "endCursor": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.rallyuxr.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
studyId
string
required

Query Parameters

​
startCursor
string

The cursor to start from

​
size
number
default:25

The number of items to return

Required range: x <= 100
Example:

10

​
bookingStates

The states of the interview bookings to filter by. If nothing is provided, all states will be included.

Available options:
SCHEDULED,
CANCELED,
COMPLETED,
NO_SHOWED

Response

The interviews

​
results
object[]
required
​
total
number
required

The total number of items in your workspaces based on your search parameters

​
pageInfo
object
required

Information about the current page