GET
/
rooms
List Rooms
curl --request GET \
  --url https://api.pagecall.com/v1/rooms \
  --header 'Authorization: Bearer <token>'
{
  "rooms": [
    {
      "id": "000585f36eed9e8fb6b655b4",
      "type": "private",
      "name": "Monthly Meeting Room with Design Class"
    },
    {
      "id": "000235f36efd9e8db6bc55b4",
      "type": "public",
      "name": "Daily Meet"
    },
    {
      "id": "000935fc6efd9f8db61c35b4",
      "type": "open",
      "name": "Free Disgn Class"
    }
  ],
  "paging": {
    "limit": 30,
    "offset": 0,
    "total": 0
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
offset
integer

The number of items to skip before starting to collect the result set

​
limit
integer

The numbers of items to return

​
name
string

Exact name of the room to search.

​
layout
string

Layout name to search.

​
is_terminated
boolean

Filter rooms by their termination status

Response

Successful operation

​
rooms
object[]
Example:
[
  {
    "id": "000585f36eed9e8fb6b655b4",
    "type": "private",
    "name": "Monthly Meeting Room with Design Class"
  },
  {
    "id": "000235f36efd9e8db6bc55b4",
    "type": "public",
    "name": "Daily Meet"
  },
  {
    "id": "000935fc6efd9f8db61c35b4",
    "type": "open",
    "name": "Free Disgn Class"
  }
]
​
paging
object

Details of pagination used for current responses.