List Rooms

GET 
/rooms

List rooms.

Permissions

The API token must include the following scopes: Video.

Request

Query Parameters

include_active_session boolean

Specifies whether or not to include information about the room's active session (if any)

Responses

200

OK

application/json

Schema

Schema

links

object

selfstring

firststring

nextstring

prevstring
dataobject[]

Example (from schema)

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "my_room",
      "display_name": "My Room's Name",
      "description": "This room will be used for full company all hands meetings",
      "max_members": 20,
      "quality": "720p",
      "join_from": "2024-07-29T15:51:28.071Z",
      "join_until": "2024-07-29T15:51:28.071Z",
      "remove_at": "2024-07-29T15:51:28.071Z",
      "remove_after_seconds_elapsed": 120,
      "layout": "grid-responsive",
      "record_on_start": true,
      "enable_room_previews": true,
      "audio_video_sync": true,
      "fps": 20,
      "active_session": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "room_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "my_example_room",
        "display_name": "My Room's Name",
        "join_from": "2024-07-29T15:51:28.071Z",
        "join_until": "2024-07-29T15:51:28.071Z",
        "remove_at": "2024-07-29T15:51:28.071Z",
        "remove_after_seconds_elapsed": 120,
        "layout": "grid-responsive",
        "max_members": 20,
        "fps": 20,
        "quality": "720p",
        "start_time": "2024-07-29T15:51:28.071Z",
        "end_time": "2024-07-29T15:51:28.071Z",
        "duration": 120,
        "status": "completed",
        "record_on_start": true,
        "enable_room_previews": true,
        "preview_url": "https://...",
        "audio_video_sync": true
      },
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ]
}