---
title: "List Rooms"
method: GET
path: "/rooms"
tags: ["room"]
---

# List Rooms

`GET /rooms`

List all accessible rooms

## Query parameters

- `offset` integer
- `limit` integer
- `name` string
- `layout` string
- `is_terminated` boolean

## Response `200`

Successful operation

- object
  - `rooms` Room[]
    - `id` string, required — ID of the room
    - `application_id` string — ID of the workspace
    - `type` 'open' | 'public' | 'private', required — Room can have three different type * `open` - anyone who obtain this room url can join and replay the meet. * `public` - any member who haved joined in same worksapce can join and replay the meet. * `private` - only invited workspace user can join and replay the meet.
    - `created_user_id` string — *[Deprecated]* ID of the user who create this room
    - `name` string, required — Human readable name of the room
    - `thumbnail_url` string — Generated thumbnail for this room
    - `last_thumbnail_updated_at` string, date-time — *[Deprecated]* Last update time of generated thumbnail
    - `room_template_id` string — *[Deprecated]* **Use `layout` instead.** ID of the room template used by this room
    - `layout` string — How the room looks
    - `record` boolean — Whether this room is recorded or not.
    - `meeting_time` integer — Total meeting time in seconds
    - `is_terminated` boolean — *[Deprecated]* **Use `terminated_at` instead.** Whether this room is terminated or not. If true, not available to join the room
    - `is_ephemeral` boolean — *[Deprecated]* Whether this room is for temporary or not. If true and all the members of this room leave, the room will be closed
    - `is_recurring` boolean — *[Deprecated]* Whether this meeting occurs regularly or not. If true, it will be reopened according to a predefined schedule.
    - `started_at` string, date-time — The meeting is started at specified time format
    - `terminated_at` string, date-time — The room is terminated at specified time format
    - `updated_at` string, date-time — The room settings are changed at specified time format
    - `created_at` string, date-time — The room is created at specified time format
  - `paging` Paging — Details of pagination used for current responses.
    - `limit` number, required
    - `offset` number, required
    - `total` number, required

## Other responses

- `400` — Invalid Parameters Supplied or Unauthenticated or Unauthorized
- `500` — Validation exception

## Changes

- **2024-02-13** `3bbf89785daa` — 1 warning
  - removed the optional property `rooms/items/members` from the response with the `200` status
- **2023-11-20** `37b071303134` — 1 info
  - added the new optional `query` request parameter `layout`
- **2023-11-20** `479af44e570f` — 1 info
  - added the optional property `rooms/items/layout` to the response with the `200` status
- **2023-11-09** `2203582ec417` — 1 info
  - added the new optional `query` request parameter `is_terminated`
- **2023-04-05** `5c2950789c4c` — 3 warning, 1 info
  - deleted the `query` request parameter `is_terminated`
  - deleted the `query` request parameter `layout`
  - removed the optional property `rooms/items/layout` from the response with the `200` status
  - added the optional property `rooms/items/members` to the response with the `200` status

[Change history](https://skmtc.dev/pplink/apis/pagecall-public-api-openapi-3-0/changes/rooms/get.md)

---

[API](https://skmtc.dev/pplink/apis/pagecall-public-api-openapi-3-0.md) · [All operations](https://skmtc.dev/pplink/apis/pagecall-public-api-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pplink/pagecall-public-api-openapi-3-0/revisions/c6a9d7e46d2a/schema)