Skip to main content

Find a Room Session by ID

Find a Room Session by ID.


The API token must include the following scopes: Video.

Path Parameters
id uuid REQUIRED

Unique ID of the Room Session



id uuid OPTIONAL

Unique ID of the session

room_id uuid OPTIONAL

Unique ID of the Room if the Session was created from a Room and was not an auto-created Session.

name string OPTIONAL

The named identifier of room session.

display_name string OPTIONAL

Display name of room, no character limitations. Maxium of 200 characters. Defaults to the value of name.

join_from date-time OPTIONAL

Room Session does not accept new Members before this time.

join_until date-time OPTIONAL

Room Session stops accepting new Members at this time.

remove_at date-time OPTIONAL

Remove Members from the Room Session at this time.

remove_after_seconds_elapsed int32 OPTIONAL

Remove Members after they are in the Room Session for N seconds.

layout string OPTIONAL

The Room Session's initial layout. Defaults to grid-responsive. See documentation for a full list of supported layouts.

max_members integer OPTIONAL

The maximum number of members allowed in the room at a time.

fps integer OPTIONAL

The Room Session's frames per second. Possible values are 20 or 30.

quality string OPTIONAL

The Room Session's resolution. Possible values are 720p or 1080p.

start_time date-time OPTIONAL
end_time date-time OPTIONAL
duration integer OPTIONAL

How long, in seconds, the Room Session lasted.

status string OPTIONAL
record_on_start boolean OPTIONAL

Whether a recording was automatically started when this Room Session began.

enable_room_previews boolean OPTIONAL

Whether a video with a preview of the content of the room is to be generated.

preview_url string OPTIONAL

If room previews are enabled and the room session is in progress, this is the URL of the preview video.