v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Rooms

View a list of rooms.

get/rooms

Query parameters

include_sessionsboolean

Example:true

To decide if room sessions should be included in the response.

unique_namestring

Unique_name for filtering rooms.

Consolidated filter parameter (deepObject style). Originally: filter[date_created_at][eq], filter[date_created_at][gte], filter[date_created_at][lte], filter[date_updated_at][eq], filter[date_updated_at][gte], filter[date_updated_at][lte], filter[unique_name]

{
  "date_created_at": {
    "eq": "2021-04-25",
    "gte": "2021-04-25",
    "lte": "2021-04-25"
  },
  "date_updated_at": {
    "eq": "2021-04-25",
    "gte": "2021-04-25",
    "lte": "2021-04-25"
  },
  "unique_name": "my_video_room"
}

numberinteger

The page number to load.

sizeinteger

The size of the page.

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Response

List rooms response.

Example response

{
  "data": [
    {
      "active_session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
      "created_at": "2021-04-16T09:46:20.954863Z",
      "enable_recording": true,
      "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
      "max_participants": 50,
      "record_type": "room",
      "sessions": [
        {
          "active": true,
          "created_at": "2021-04-16T09:46:20.954863Z",
          "id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
          "participants": [],
          "record_type": "room_session",
          "room_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
          "updated_at": "2021-04-16T10:24:55.962200Z"
        }
      ],
      "unique_name": "My Room",
      "updated_at": "2021-04-16T10:24:55.962200Z",
      "webhook_event_failover_url": "https://failover.example.com",
      "webhook_event_url": "https://www.example.com",
      "webhook_timeout_secs": 25
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}