> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt # get > Retrieve a single room session. Retrieve a single room session by its unique identifier. ### Schema ```yaml openapi: 3.1.0 info: title: API version: 1.0.0 paths: /api/video/room_sessions/{id}: get: operationId: get_room_session summary: Get room session description: >- 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). tags: - subpackage_roomSessions parameters: - name: id in: path description: Unique ID of the Room Session. required: true schema: $ref: '#/components/schemas/uuid' responses: '200': description: Room session response. content: application/json: schema: $ref: '#/components/schemas/Video.RoomSessionSummary' '400': description: The request is invalid. content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode400' '401': description: Access is unauthorized. content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode401' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode404' '500': description: An internal server error occurred. content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode500' servers: - url: https://%7BYour_Space_Name%7D.signalwire.com description: SignalWire API components: schemas: uuid: type: string format: uuid description: Universal Unique Identifier. title: uuid Video.VideoQuality: type: string enum: - 720p - 1080p description: Video quality resolution. title: Video.VideoQuality Video.VideoFps: type: string enum: - '20' - '30' description: Video frames per second. title: Video.VideoFps Video.RoomSessionStatus: type: string enum: - in-progress - completed description: Status of a room session. title: Video.RoomSessionStatus Video.RoomSessionSummary: type: object properties: id: $ref: '#/components/schemas/uuid' description: Unique ID of the session. room_id: oneOf: - $ref: '#/components/schemas/uuid' - type: 'null' description: >- Unique ID of the Room if the Session was created from a Room and was not an auto-created Session. Null if the room was set to delete on end. name: type: - string - 'null' description: The named identifier of the room session. display_name: type: - string - 'null' description: >- Display name of the room. Maximum of 200 characters. Defaults to the value of name. max_members: type: - integer - 'null' description: The maximum number of members allowed in the room at a time. quality: oneOf: - $ref: '#/components/schemas/Video.VideoQuality' - type: 'null' description: The room session's resolution. fps: oneOf: - $ref: '#/components/schemas/Video.VideoFps' - type: 'null' description: The room session's frames per second. join_from: type: - string - 'null' format: date-time description: Room Session does not accept new Members before this time. join_until: type: - string - 'null' format: date-time description: Room Session stops accepting new Members at this time. remove_at: type: - string - 'null' format: date-time description: Remove Members from the Room Session at this time. remove_after_seconds_elapsed: type: - integer - 'null' description: Remove Members after they are in the Room Session for N seconds. layout: type: - string - 'null' description: The room session's initial layout. record_on_start: type: boolean description: >- Whether a recording was automatically started when this Room Session began. tone_on_entry_and_exit: type: boolean description: >- Whether a tone is played when a member enters or exits the room session. room_join_video_off: type: boolean description: Whether participants join with video off by room setting. user_join_video_off: type: boolean description: Whether participants join with video off by user setting. locked: type: boolean description: Whether the room session is locked. start_time: type: - string - 'null' format: date-time description: Start time of the session. end_time: type: - string - 'null' format: date-time description: End time of the session. duration: type: - integer - 'null' description: How long, in seconds, the Room Session lasted. status: oneOf: - $ref: '#/components/schemas/Video.RoomSessionStatus' - type: 'null' description: Status of the session. created_at: type: string format: date-time description: Timestamp when the room session was created. updated_at: type: string format: date-time description: Timestamp when the room session was last updated. preview_url: type: - string - 'null' description: >- If room previews are enabled and the room session is in progress, this is the URL of the preview video. prioritize_handraise: type: - boolean - 'null' description: Whether raised hands are prioritized in the layout. sync_audio_video: type: - boolean - 'null' description: Enable/disable jitter buffer audio-video sync. required: - id - room_id - name - display_name - max_members - quality - fps - join_from - join_until - remove_at - remove_after_seconds_elapsed - layout - record_on_start - tone_on_entry_and_exit - room_join_video_off - user_join_video_off - locked - start_time - end_time - duration - status - created_at - updated_at - preview_url - prioritize_handraise - sync_audio_video description: >- Room session summary, returned by the show endpoint. Omits list-only fields. title: Video.RoomSessionSummary TypesStatusCodesStatusCode400Error: type: string enum: - Bad Request title: TypesStatusCodesStatusCode400Error Types.StatusCodes.StatusCode400: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode400Error' required: - error description: The request is invalid. title: Types.StatusCodes.StatusCode400 TypesStatusCodesStatusCode401Error: type: string enum: - Unauthorized title: TypesStatusCodesStatusCode401Error Types.StatusCodes.StatusCode401: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error' required: - error description: Access is unauthorized. title: Types.StatusCodes.StatusCode401 TypesStatusCodesStatusCode404Error: type: string enum: - Not Found title: TypesStatusCodesStatusCode404Error Types.StatusCodes.StatusCode404: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error' required: - error description: The server cannot find the requested resource. title: Types.StatusCodes.StatusCode404 TypesStatusCodesStatusCode500Error: type: string enum: - Internal Server Error title: TypesStatusCodesStatusCode500Error Types.StatusCodes.StatusCode500: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error' required: - error description: An internal server error occurred. title: Types.StatusCodes.StatusCode500 ``` ## **Response Example** ### Response (200) ```json { "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92", "room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890", "name": "my_example_room", "display_name": "My Room's Name", "max_members": 20, "quality": "720p", "fps": 20, "join_from": "2022-01-01T00:00:00Z", "join_until": "2022-12-31T23:59:59Z", "remove_at": "2022-12-31T23:59:59Z", "remove_after_seconds_elapsed": 120, "layout": "grid-responsive", "record_on_start": false, "tone_on_entry_and_exit": true, "room_join_video_off": false, "user_join_video_off": false, "locked": false, "start_time": "2022-01-01T10:00:00Z", "end_time": "2022-01-01T11:00:00Z", "duration": 120, "status": "completed", "created_at": "2022-01-01T10:00:00Z", "updated_at": "2022-01-01T11:00:00Z", "preview_url": "https://example.signalwire.com/preview/abc123", "prioritize_handraise": false, "sync_audio_video": true } ``` ## **Example** ```python {9} from signalwire.rest import RestClient client = RestClient( project="your-project-id", token="your-api-token", host="your-space.signalwire.com", ) session = client.video.room_sessions.get("session-id") ```