Rooms
List rooms
List rooms.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.
Learn more about API scopes.
get/api/video/rooms
Query parameters
include_active_sessionboolean
Specifies whether or not to include information about the room's active session (if any).
starts_afterstring
Return rooms with a join_from date on or after this date. Expects RFC 3339 datetime or date string.
ends_beforestring
Return rooms with a join_until date on or before this date. Expects RFC 3339 datetime or date string.
page_numberinteger
Page number to return. Requires page_token for values greater than 0.
page_sizeinteger
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstring
Token for cursor-based pagination. Required when page_number is greater than 0.
Response
The request has succeeded.
Example response
{
"links": {
"self": "https://example.signalwire.com/api/video/rooms?page=2",
"first": "https://example.signalwire.com/api/video/rooms?page=1",
"next": "https://example.signalwire.com/api/video/rooms?page=3",
"prev": "https://example.signalwire.com/api/video/rooms?page=1"
},
"data": [
{
"name": "my_room",
"display_name": "My Room's Name",
"description": "This room will be used for full company all hands meetings",
"max_members": 20,
"fps": 20,
"join_from": "2022-01-01T00:00:00Z",
"join_until": "2022-12-31T23:59:59Z",
"remove_at": "2022-12-31T23:59:59Z",
"remove_after_seconds_elapsed": 120,
"tone_on_entry_and_exit": true,
"sync_audio_video": true,
"meta": {},
"active_session": {
"id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
"room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
"name": "my_example_room",
"display_name": "My Room's Name",
"join_from": "2022-01-01T00:00:00Z",
"join_until": "2022-12-31T23:59:59Z",
"remove_at": "2022-12-31T23:59:59Z",
"remove_after_seconds_elapsed": 120,
"layout": "grid-responsive",
"max_members": 20,
"start_time": "2022-01-01T10:00:00Z",
"end_time": "2022-01-01T11:00:00Z",
"duration": 120,
"record_on_start": true,
"enable_room_previews": true,
"preview_url": "https://example.signalwire.com/api/video/room_sessions/c22d24f6-5a47-4597-9a23-c7d01e696b92/preview",
"audio_video_sync": true
},
"created_at": "2022-01-01T10:00:00Z",
"updated_at": "2022-01-01T11:00:00Z"
}
]
}