List

To list the existing rooms you need to execute a GET request against the /rooms endpoint.

Since potentially there could be thousands of rooms, pagination is supported with limit, order and after arguments. Read about pagination to learn the details of it. By default maximum 100 rooms will be returned in the response.

If you want to retrieve the details of one concrete room execute a GET request against the /rooms/:id endpoint

Request (listing all rooms)

curl --request GET \
  --url https://api.digitalsamba.com/api/v1/rooms \
  --user YOUR_TEAM_ID:YOUR_DEVELOPER_KEY

Response (200 OK)

{
    "total_count": 6124,
    "data": [
        {
            "id": "c39d7c40-7ff7-4faa-b06f-698a639a9523",
            "friendly_url": "my-test-meeting",
            "privacy": "public",
            ...................
        },
        ...............99 more rooms...............
    ]
} 

The total_count is the total amount of rooms you have globally. It is NOT the amount of rooms in the current page returned in the data array. In the above example you have 6124 rooms in total, but in the data array there will be maximum 100 rooms (the default limit argument value).

Request (get a concrete room)

curl --request GET \
  --url https://api.digitalsamba.com/api/v1/rooms/c39d7c40-7ff7-4faa-b06f-698a639a9523 \
  --user YOUR_TEAM_ID:YOUR_DEVELOPER_KEY

Response (200 OK)

{
    "id": "c39d7c40-7ff7-4faa-b06f-698a639a9523",
    "friendly_url": "my-test-meeting",
    "privacy": "public",
    ...................
} 

Last updated