---
title: "Show information about all rooms"
method: GET
path: "/room"
tags: ["room"]
---

# Show information about all rooms

`GET /room`

## Response `200`

Success

- RoomsListingResponse — Response containing list of all rooms
  - `data` Room[], required
    - `components` Component[], required — List of all components
      - union — Describes component
        - object — Describes the HLS component
          - `id` string, required — Assigned component ID
          - `properties` ComponentPropertiesHLS, required — Properties specific to the HLS component
            - `lowLatency` boolean, required — Whether the component uses LL-HLS
            - `persistent` boolean, required — Whether the video is stored after end of stream
            - `playable` boolean, required — Whether the generated HLS playlist is playable
            - `subscribeMode` 'auto' | 'manual', required — Whether the HLS component should subscribe to tracks automatically or manually
            - `targetWindowDuration` integer, nullable, required — Duration of stream available for viewer
          - `tracks` Track[], required — List of all component's tracks
            - `id` string
            - `metadata` unknown
            - `type` 'audio' | 'video'
          - `type` string, required — Component type
        - object — Describes the RTSP component
          - `id` string, required — Assigned component ID
          - `properties` ComponentPropertiesRTSP, required — Properties specific to the RTSP component
            - `keepAliveInterval` integer, required — Interval (in ms) in which keep-alive RTSP messages will be sent to the remote stream source
            - `pierceNat` boolean, required — Whether to attempt to create client-side NAT binding by sending an empty datagram from client to source, after the completion of RTSP setup
            - `reconnectDelay` integer, required — Delay (in ms) between successive reconnect attempts
            - `rtpPort` integer, required — Local port RTP stream will be received at
            - `sourceUri` string, required — URI of RTSP source stream
          - `tracks` Track[], required — List of all component's tracks
            - `id` string
            - `metadata` unknown
            - `type` 'audio' | 'video'
          - `type` string, required — Component type
        - object — Describes the File component
          - `id` string, required — Assigned component ID
          - `properties` ComponentPropertiesFile — Properties specific to the File component
            - `filePath` string, required — Relative path to track file. Must be either OPUS encapsulated in Ogg or raw h264
            - `framerate` integer, nullable, required — Framerate of video in a file. It is only valid for video track
          - `tracks` Track[], required — List of all component's tracks
            - `id` string
            - `metadata` unknown
            - `type` 'audio' | 'video'
          - `type` string, required — Component type
        - object — Describes the SIP component
          - `id` string, required — Assigned component ID
          - `properties` ComponentPropertiesSIP, required — Properties specific to the SIP component
            - `registrarCredentials` object, required — Credentials used to authorize in SIP Provider service
              - …
          - `tracks` Track[], required — List of all component's tracks
            - `id` string
            - `metadata` unknown
            - `type` 'audio' | 'video'
          - `type` string, required — Component type
        - object — Describes the Recording component
          - `id` string, required — Assigned component ID
          - `properties` ComponentPropertiesRecording, required — Properties specific to the Recording component
            - `subscribeMode` 'auto' | 'manual', required — Whether the Recording component should subscribe to tracks automatically or manually
          - `tracks` Track[], required — List of all component's tracks
            - `id` string
            - `metadata` unknown
            - `type` 'audio' | 'video'
          - `type` string, required — Component type
    - `config` RoomConfig, required — Room configuration
      - `maxPeers` integer, nullable — Maximum amount of peers allowed into the room
      - `peerDisconnectedTimeout` integer, nullable — Duration (in seconds) after which the peer will be removed if it is disconnected. If not provided, this feature is disabled.
      - `peerlessPurgeTimeout` integer, nullable — Duration (in seconds) after which the room will be removed if no peers are connected. If not provided, this feature is disabled.
      - `roomId` string, nullable — Custom id used for identifying room within Fishjam. Must be unique across all rooms. If not provided, random UUID is generated.
      - `videoCodec` 'h264' | 'vp8', nullable — Enforces video codec for each peer in the room
      - `webhookUrl` string, nullable — URL where Fishjam notifications will be sent
    - `id` string, required — Room ID
    - `peers` Peer[], required — List of all peers
      - `id` string, required — Assigned peer id
      - `metadata` unknown, required
      - `status` 'connected' | 'disconnected', required — Informs about the peer status
      - `tracks` Track[], required — List of all peer's tracks
        - `id` string
        - `metadata` unknown
        - `type` 'audio' | 'video'
      - `type` string, required — Peer type

## Other responses

- `401` — Unauthorized

## Changes

> 50 revisions in range; 1 could not be searched.

- **2024-04-17** `9c9961e4aa93` — 1 info
  - added the optional property `data/items/config/peerDisconnectedTimeout` to the response with the `200` status
- **2024-04-09** `432be2bc83f5` — 1 breaking, 1 info
  - removed the required property `data/items/components/items/oneOf[subschema #5: ComponentRecording]/properties/pathPrefix` from the response with the `200` status
  - added the required property `data/items/components/items/oneOf[subschema #5: ComponentRecording]/properties/subscribeMode` to the response with the `200` status
- **2024-03-14** `a91eab8f5c5d` — 1 breaking, 1 info
  - added `#/components/schemas/ComponentRecording` to the `data/items/components/items/` response property `oneOf` list for the response status `200`
  - added `recording` discriminator mapping keys to the `data/items/components/items/` response property for the response status `200`
- **2024-02-22** `4f1bea96a0f9` — 1 info
  - the endpoint scheme security `authorization` was added to the API
- **2024-02-19** `f04645633559` — 1 breaking, 1 info
  - added `#/components/schemas/ComponentSIP` to the `data/items/components/items/` response property `oneOf` list for the response status `200`
  - added `sip` discriminator mapping keys to the `data/items/components/items/` response property for the response status `200`

[Full history](https://skmtc.dev/fishjam-dev/apis/fishjam-media-server/changes/room/get.md)

---

[API](https://skmtc.dev/fishjam-dev/apis/fishjam-media-server.md) · [All operations](https://skmtc.dev/fishjam-dev/apis/fishjam-media-server/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fishjam-dev/fishjam-media-server/revisions/7227c4e436c0/schema)