> This page is for APIs.

> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# List rooms

GET https://%7BYour_Space_Name%7D.signalwire.com/api/video/rooms

Lists the project's reusable Video Rooms for SDK-based video experiences. Use [Get room](/docs/apis/rest/video/rooms/get-room) when you already have a room ID, or [Get room by name](/docs/apis/rest/video/rooms/get-room-by-name) when your application stores the room's unique name.

#### 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](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/apis/rest/video/rooms/list-rooms

## Authentication

- `Authorization` header (basic auth, required) — SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

## Request

### Query parameters

- `include_active_session` (boolean, optional) — Specifies whether or not to include information about the room's active session (if any).
- `starts_after` (string, optional) — Return rooms with a join_from date on or after this date. Expects RFC 3339 datetime or date string.
- `ends_before` (string, optional) — Return rooms with a join_until date on or before this date. Expects RFC 3339 datetime or date string.
- `page_number` (integer, optional, default: 0) — Page number to return. Requires `page_token` for values greater than 0.
- `page_size` (integer, optional, default: 50) — Specify the number of results to return on a single page. The default page size is `50` and the maximum is `1000`.
- `page_token` (string, optional) — Token for cursor-based pagination. Required when `page_number` is greater than 0.

## Response

### 200

The request has succeeded.

- `links` (Video.PaginationLinks, required) — Pagination links.
- `data` (list of Video.RoomResponse, required) — List of rooms.

## Errors

### 400 Bad Request Error

The request is invalid.

- `error` (enum, required)
  - Allowed values: `Bad Request`

### 401 Unauthorized Error

Access is unauthorized.

- `error` (enum, required)
  - Allowed values: `Unauthorized`

### 422 Unprocessable Entity Error

The request contains invalid parameters. See errors for details.

- `errors` (list of Types.StatusCodes.RestApiErrorItem, required) — List of validation errors.

### 500 Internal Server Error

An internal server error occurred.

- `error` (enum, required)
  - Allowed values: `Internal Server Error`

## Types

### Video.PaginationLinks

Pagination links for list responses.

- `self` (string, required) — Link to the current page.
- `first` (string, required) — Link to the first page.
- `next` (string, optional) — Link to the next page.
- `prev` (string, optional) — Link to the previous page.

### Video.RoomResponse

Room response object.

- `id` (string, required) — A unique identifier for the room.
- `name` (string, required) — A named unique identifier for the room.
- `display_name` (string, required, nullable) — Display name of the room.
- `description` (string, required, nullable) — Description of the room.
- `max_members` (integer, required) — The maximum number of members in the room at a time.
- `quality` (enum, required) — The room's resolution.
  - Allowed values: `720p`, `1080p`
- `fps` (integer, required) — Frames per second parameter of room video quality.
- `join_from` (datetime, required, nullable) — Room does not accept new participants before this time.
- `join_until` (datetime, required, nullable) — Room stops accepting new participants at this time.
- `remove_at` (datetime, required, nullable) — Remove users from the room at this time.
- `remove_after_seconds_elapsed` (integer, required, nullable) — Remove users after they are in the room for N seconds.
- `layout` (enum, required) — The room's initial layout.
  - Allowed values: `grid-responsive`, `grid-responsive-mobile`, `highlight-1-responsive`, `1x1`, `2x1`, `2x2`, `5up`, `3x3`, `4x4`, `5x5`, `6x6`, `8x8`, `10x10`
- `record_on_start` (boolean, required) — Specifies whether to start recording a Room Session when one is started for this Room.
- `tone_on_entry_and_exit` (boolean, required) — Whether a tone is played when participants enter or exit the room.
- `room_join_video_off` (boolean, required) — Whether the room's video is turned off when participants join.
- `user_join_video_off` (boolean, required) — Whether a user's video is turned off when they join the room.
- `enable_room_previews` (boolean, required, nullable) — Whether a video with a preview of the content of the room is to be generated.
- `sync_audio_video` (boolean, required, nullable) — Enable/disable jitter buffer audio-video sync.
- `meta` (VideoRoomResponseMeta, required, nullable) — User-defined metadata for the room.
- `prioritize_handraise` (boolean, required) — Whether hand raises are prioritized in the room layout.
- `created_at` (datetime, required) — Timestamp when the room was created.
- `updated_at` (datetime, required) — Timestamp when the room was last updated.
- `active_session` (Video.ActiveSession, optional) — Active session information for the room.

### Types.StatusCodes.RestApiErrorItem

Details about a specific error.

- `type` (string, required) — The category of error.
- `code` (string, required) — A specific error code.
- `message` (string, required) — A description of what caused the error.
- `url` (string, required) — A link to documentation about this error.
- `attribute` (string, optional, nullable) — The request parameter that caused the error, if applicable.

### VideoRoomResponseMeta

User-defined metadata for the room.

### Video.ActiveSession

Active session information for a room.

- `id` (string, optional) — Unique ID of the session.
- `room_id` (string, optional) — Unique ID of the Room if the Session was created from a Room and was not an auto-created Session.
- `name` (string, optional) — The named identifier of room session.
- `display_name` (string, optional) — Display name of room, no character limitations. Maximum of 200 characters. Defaults to the value of name.
- `join_from` (datetime, optional) — Room Session does not accept new Members before this time.
- `join_until` (datetime, optional) — Room Session stops accepting new Members at this time.
- `remove_at` (datetime, optional) — Remove Members from the Room Session at this time.
- `remove_after_seconds_elapsed` (integer, optional) — Remove Members after they are in the Room Session for N seconds.
- `layout` (string, optional) — The Room Session's initial layout. See documentation for a full list of supported layouts.
- `max_members` (integer, optional) — The maximum number of members allowed in the room at a time.
- `fps` (enum, optional) — The Room Session's frames per second.
  - Allowed values: `20`, `30`
- `quality` (enum, optional) — The Room Session's resolution.
  - Allowed values: `720p`, `1080p`
- `start_time` (datetime, optional) — Start time of the session.
- `end_time` (datetime, optional) — End time of the session.
- `duration` (integer, optional) — How long, in seconds, the Room Session lasted.
- `status` (enum, optional) — Status of the session.
  - Allowed values: `in-progress`, `completed`
- `record_on_start` (boolean, optional) — Whether a recording was automatically started when this Room Session began.
- `enable_room_previews` (boolean, optional) — Whether a video with a preview of the content of the room is to be generated.
- `preview_url` (string, optional) — If room previews are enabled and the room session is in progress, this is the URL of the preview video.
- `audio_video_sync` (boolean, optional) — Enable/disable jitter buffer audio-video sync.

## Examples

**Response**

```json
{
  "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": [
    {
      "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
      "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",
      "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,
      "layout": "grid-responsive",
      "record_on_start": false,
      "tone_on_entry_and_exit": true,
      "room_join_video_off": false,
      "user_join_video_off": false,
      "enable_room_previews": false,
      "sync_audio_video": true,
      "meta": {},
      "prioritize_handraise": false,
      "created_at": "2022-01-01T10:00:00Z",
      "updated_at": "2022-01-01T11:00:00Z",
      "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,
        "fps": 20,
        "quality": "720p",
        "start_time": "2022-01-01T10:00:00Z",
        "end_time": "2022-01-01T11:00:00Z",
        "duration": 120,
        "status": "completed",
        "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
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://{your_space_name}.signalwire.com/api/video/rooms"

response = requests.get(url, auth=("<project_id>", "<api_token>"))

print(response.json())
```

```javascript
const url = 'https://{your_space_name}.signalwire.com/api/video/rooms';
const credentials = btoa("<project_id>:<api_token>");

const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{your_space_name}.signalwire.com/api/video/rooms"

	req, _ := http.NewRequest("GET", url, nil)

	req.SetBasicAuth("<project_id>", "<api_token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://{your_space_name}.signalwire.com/api/video/rooms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request.basic_auth("<project_id>", "<api_token>")

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://{your_space_name}.signalwire.com/api/video/rooms")
  .basicAuth("<project_id>", "<api_token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://{your_space_name}.signalwire.com/api/video/rooms', [
  'headers' => [
  ],
    'auth' => ['<project_id>', '<api_token>'],
]);

echo $response->getBody();
```

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://{your_space_name}.signalwire.com/api/video/rooms");
client.Authenticator = new HttpBasicAuthenticator("<project_id>", "<api_token>");
var request = new RestRequest(Method.GET);

IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<project_id>:<api_token>".utf8).base64EncodedString()

let headers = ["Authorization": "Basic \(credentials)"]

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/video/rooms")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```