List rooms

Overview

This API retrieves details of a list of rooms in your account. 100ms provides options to

retrieve the complete list of rooms or
rooms that are enabled/disabled or
rooms based on their creation time-range or
combinations of these.

List all rooms

This API retrieves details of all the rooms in your account.


curl --location --request GET 'https://api.100ms.live/v2/rooms' \
--header 'Authorization: Bearer <management_token>'

RESPONSE

Status: 200 OK


{
    "limit": 10,
    "data": [
        {
            "id": "62bbc84********0a6aa1a",
            "name": "test-room",
            "enabled": true,
            "description": "This is a test room",
            "customer_id": "627cda********a39291b",
            "recording_source_template": true,
            "template_id": "627cd********784227d3",
            "template": "default_createown_e319635a-****-****-****-ae9e95891e31",
            "region": "in",
            "created_at": "2022-06-29T03:34:30.194Z",
            "key": "627***********a39291b:test-room",
            "updated_at": "0001-01-01T00:00:00Z"
            "large_room": false,
            "max_duration_seconds": 10000
        },
        {
            "id": "627cda81********6b077bc33",
            "name": "4b2705aa-****-****-****-f470c06d0c03",
            "enabled": true,
            "description": "This is a test room",
            "customer_id": "627cd********037a39291b",
            "recording_source_template": false,
            "recording": {
                "enabled": false
            },
            "template_id": "627cda********84227d3",
            "template": "default_createown_e319635a-****-****-****-ae9e95891e31",
            "region": "in",
            "created_at": "2022-05-12T09:59:29.343Z",
            "key": "627cda********037a39291b:4b2705aa-****-****-****-f470c06d0c03",
            "updated_at": "0001-01-01T00:00:00Z"
            "large_room": true,
            "size":19000,
            "max_duration_seconds": 2000
        }
    ],
    "last": "627cda81bd4f3b56b077bc33"
}

Allowed filters

Name	Type	Description	Required
enabled	`boolean`	Flag to indicate if the room is enabled. `Default`: true, `Allowed values`: true, false	No
after	`string`	Check for rooms created with a timestamp greater than or equal to "after" `Format`: YYYY-MM-DDTHH:mm:ss.sssZ.	No
before	`string`	Check for rooms created with a timestamp less than or equal to "before" `Format`: YYYY-MM-DDTHH:mm:ss.sssZ.	No
name	`string`	Filter the result based on the room name. For example "test-room". The room name would look like `7faa6631-5503-4535-b53e-4abe9230e139` if you didn't provide a name during room creation.	No
limit	`int`	Determines the number of room objects to be included in response. `Default`: 10, `Allowed values`: Min: 10, Max: 100	No
start	`string`	Determines the starting point. `last` field of the response can be used as start for the subsequent request. For example "627cda81ab4f3b56a077dc33".	No
template_id	`string`	Filter the result based on the template ID	NO

Retrieve a specific room Update a room

Have a suggestion? Recommend changes ->