Skip to main content
GET
/
studies
/
{studyId}
/
observer-rooms
Get the observer rooms for a study
curl --request GET \
  --url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/observer-rooms \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "observerRoomId": "<string>",
      "interviewBookingId": "<string>",
      "studyId": "<string>",
      "title": "<string>",
      "note": "<string>",
      "guestUserIds": [
        "<string>"
      ],
      "externalGuests": [
        "<string>"
      ],
      "bots": [
        {
          "observerRoomBotId": "<string>",
          "observerRoomId": "<string>",
          "status": "SCHEDULED",
          "subscriptionStatus": "HEALTHY",
          "liveStreamStatus": "NOT_STARTED",
          "source": "SCHEDULED",
          "video": {
            "hasVideo": true,
            "downloadUrl": "<string>"
          },
          "transcript": {
            "hasTranscript": true,
            "transcriptUrl": "<string>",
            "shortSummary": "<string>",
            "longSummary": "<string>"
          }
        }
      ]
    }
  ],
  "total": 123,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "<string>",
    "endCursor": "<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

Query Parameters

startCursor
string

The cursor to start from

size
number
default:25

The number of items to return

Required range: 0 < x <= 100
Example:

10

Response

The observer rooms

results
object[]
required
total
number
required

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

Required range: x > 0
pageInfo
object
required

Information about the current page