---
title: "Get room session"
method: GET
path: "/api/video/room_sessions/{id}"
tags: ["Room Sessions"]
---

# Get room session

`GET /api/video/room_sessions/{id}`

Find a Room Session by ID.

#### 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).

## Path parameters

- `id` string, uuid, required — Universal Unique Identifier.

## Response `200`

Room session response.

- VideoRoomSessionSummary — Room session summary, returned by the show endpoint. Omits list-only fields.
  - `id` string, uuid, required — Universal Unique Identifier.
  - `room_id` string, uuid, required — Universal Unique Identifier.
  - `name` string, nullable, required — The named identifier of the room session.
  - `display_name` string, nullable, required — Display name of the room. Maximum of 200 characters. Defaults to the value of name.
  - `max_members` integer, nullable, required — The maximum number of members allowed in the room at a time.
  - `quality` '720p' | '1080p', required — Video quality resolution.
  - `fps` 20 | 30, required — Video frames per second.
  - `join_from` string, date-time, nullable, required — Room Session does not accept new Members before this time.
  - `join_until` string, date-time, nullable, required — Room Session stops accepting new Members at this time.
  - `remove_at` string, date-time, nullable, required — Remove Members from the Room Session at this time.
  - `remove_after_seconds_elapsed` integer, nullable, required — Remove Members after they are in the Room Session for N seconds.
  - `layout` string, nullable, required — The room session's initial layout.
  - `record_on_start` boolean, required — Whether a recording was automatically started when this Room Session began.
  - `tone_on_entry_and_exit` boolean, required — Whether a tone is played when a member enters or exits the room session.
  - `room_join_video_off` boolean, required — Whether participants join with video off by room setting.
  - `user_join_video_off` boolean, required — Whether participants join with video off by user setting.
  - `locked` boolean, required — Whether the room session is locked.
  - `start_time` string, date-time, nullable, required — Start time of the session.
  - `end_time` string, date-time, nullable, required — End time of the session.
  - `duration` integer, nullable, required — How long, in seconds, the Room Session lasted.
  - `status` 'in-progress' | 'completed', required — Status of a room session.
  - `created_at` string, date-time, required — Timestamp when the room session was created.
  - `updated_at` string, date-time, required — Timestamp when the room session was last updated.
  - `preview_url` string, nullable, required — If room previews are enabled and the room session is in progress, this is the URL of the preview video.
  - `prioritize_handraise` boolean, nullable, required — Whether raised hands are prioritized in the layout.
  - `sync_audio_video` boolean, nullable, required — Enable/disable jitter buffer audio-video sync.

## Other responses

- `400` — The request is invalid.
- `401` — Access is unauthorized.
- `404` — The server cannot find the requested resource.
- `500` — An internal server error occurred.

---

[API](https://skmtc.net/signalwire/apis/signalwire-rest-api.md) · [All operations](https://skmtc.net/signalwire/apis/signalwire-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/signalwire/signalwire-rest-api/revisions/05c5164b85c7/schema)