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

# List Rooms

`GET /v1/rooms`

List Rooms by various filters.  You must provide the `company_sid` param at a minimum.

## Query parameters

- `created_by_user_sid` string
- `company_sid` string
- `reference_id` string
- `integration_id` string
- `page_size` integer
- `page_token` string

## Response `200`

Successfully fetched rooms for given company_sid and query params

- StreemApiListRoomsResponse
  - `rooms` StreemApiRoom[]
    - `sid` string
    - `created_by_user_sid` string
    - `created_at` string, date-time
    - `opened_at` string, date-time
    - `preferred_video_codec` 'VIDEO_CODEC_H264' | 'VIDEO_CODEC_VP8' | 'VIDEO_CODEC_VP9' | 'VIDEO_CODEC_INVALID'
    - `status` 'STATUS_OPEN' | 'STATUS_CLOSED' | 'STATUS_INVALID'
    - `closed_at` string, date-time
    - `twilio_room_sid` string
    - `reference_id` string
    - `participants` StreemApiRoomParticipant[]
      - `room_sid` string
      - `user_sid` string
      - `status` 'STATUS_PENDING' | 'STATUS_ACTIVE' | 'STATUS_LEFT' | 'STATUS_NEVER_ARRIVED' | 'STATUS_RECONNECTING' | 'STATUS_CONNECTED' | 'STATUS_INVALID'
      - `is_expert` boolean
    - `company_sid` string
    - `video_platform` 'VIDEO_PLATFORM_TWILIO' | 'VIDEO_PLATFORM_ARAAS' | 'VIDEO_PLATFORM_CHIME' | 'VIDEO_PLATFORM_INVALID'
    - `deleted` boolean
    - `deleted_at` string, date-time
    - `encrypted_wall_items` boolean
    - `wall_platform` 'WALL_PLATFORM_TWILIO' | 'WALL_PLATFORM_STREEM' | 'WALL_PLATFORM_INVALID'
    - `integration_id` string
    - `details` StreemApiRoomDetail[]
      - `label` string
      - `value` string
    - `reservation_sid` string
    - `room_invitations` StreemApiRoomInvitation[]
      - `sid` string
      - `room_sid` string
      - `status` 'STATUS_PENDING' | 'STATUS_ACCEPTED' | 'STATUS_REJECTED' | 'STATUS_CANCELED' | 'STATUS_TIMED_OUT' | 'STATUS_INVALID'
      - `from_user_sid` string
      - `from_device_sid` string
      - `to_user_sid` string
      - `to_device_sid` string
      - `pending_at` string, date-time
      - `accepted_at` string, date-time
      - `rejected_at` string, date-time
      - `timed_out_at` string, date-time
      - `canceled_at` string, date-time
    - `chime_room_sid` string
    - `recording_started_at` string, date-time
    - `call_duration` GoogleProtobufDuration
      - `seconds` integer
      - `nanos` integer
    - `call_detail` StreemApiCallDetail
      - `sid` string
      - `call_source_sid` string
      - `items` StreemApiCallDetailItem[]
        - `sid` string
        - `description` string
        - `manufacturer` string
        - `brand` string
        - `model_number` string
        - `symptoms` string[]
        - `trade_description` string
      - `customer` StreemApiCallDetailCustomer
        - `name` string
        - `plan_type` string
        - `contract_number` string
        - `calls_available` integer
        - `address` string
        - `hvac_eligible` boolean
      - `call_source_code` string
      - `transferred` boolean
      - `requeued` boolean
      - `transfer_to_group_name` string
    - `reservation_group` StreemApiGroup
      - `name` string
      - `description` string
      - `sid` string
      - `image_url` string
      - `working_hours_by_day` StreemApiGroupHours[]
        - `day` 'DAYS_OF_WEEK_SUNDAY' | 'DAYS_OF_WEEK_MONDAY' | 'DAYS_OF_WEEK_TUESDAY' | 'DAYS_OF_WEEK_WEDNESDAY' | 'DAYS_OF_WEEK_THURSDAY' | 'DAYS_OF_WEEK_FRIDAY' | 'DAYS_OF_WEEK_SATURDAY' | 'DAYS_OF_WEEK_INVALID'
        - `start_time_utc` string
        - `end_time_utc` string
        - `time_zone_id` string
  - `next_page_token` string
  - `total_size` integer

## Other responses

- `400` — Page token was provided but endpoint pagination is not yet implemented
- `403` — User does not have permission to fetch list of rooms for this user or company

---

[API](https://skmtc.net/streem/apis/streem-api.md) · [All operations](https://skmtc.net/streem/apis/streem-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/streem/streem-api/versions/04250faebd19/schema)
