---
title: "View a list of rooms."
method: GET
path: "/rooms"
tags: ["Rooms"]
---

# View a list of rooms.

`GET /rooms`

## Query parameters

- `include_sessions` boolean
- `filter` object
  - `date_created_at` object
    - `eq` string, date — ISO 8601 date for filtering rooms created on that date.
    - `gte` string, date — ISO 8601 date for filtering rooms created on or after that date.
    - `lte` string, date — ISO 8601 date for filtering rooms created on or before that date.
  - `date_updated_at` object
    - `eq` string, date — ISO 8601 date for filtering rooms updated on that date.
    - `gte` string, date — ISO 8601 date for filtering rooms updated on or after that date.
    - `lte` string, date — ISO 8601 date for filtering rooms updated on or before that date.
  - `unique_name` string — Unique_name for filtering rooms.
- `page[number]` integer
- `page[size]` integer

## Response `200`

List rooms response.

- object
  - `data` Room[]
    - `id` string, uuid — A unique identifier for the room.
    - `max_participants` integer — Maximum participants allowed in the room.
    - `unique_name` string — The unique (within the Telnyx account scope) name of the room.
    - `created_at` string, date-time — ISO 8601 timestamp when the room was created.
    - `updated_at` string, date-time — ISO 8601 timestamp when the room was updated.
    - `active_session_id` string, uuid — The identifier of the active room session if any.
    - `sessions` RoomSession[]
      - `id` string, uuid — A unique identifier for the room session.
      - `room_id` string, uuid — Identify the room hosting that room session.
      - `active` boolean — Shows if the room session is active or not.
      - `created_at` string, date-time — ISO 8601 timestamp when the room session was created.
      - `updated_at` string, date-time — ISO 8601 timestamp when the room session was updated.
      - `ended_at` string, date-time — ISO 8601 timestamp when the room session has ended.
      - `participants` RoomParticipant[]
        - `id` string, uuid — A unique identifier for the room participant.
        - `session_id` string, uuid — Identify the room session that participant is part of.
        - `context` string — Context provided to the given participant through the client SDK
        - `joined_at` string, date-time — ISO 8601 timestamp when the participant joined the session.
        - `updated_at` string, date-time — ISO 8601 timestamp when the participant was updated.
        - `left_at` string, date-time — ISO 8601 timestamp when the participant left the session.
        - `record_type` string
      - `record_type` string
    - `enable_recording` boolean — Enable or disable recording for that room.
    - `webhook_event_url` string, uri — The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'.
    - `webhook_event_failover_url` string, uri — The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
    - `webhook_timeout_secs` integer — Specifies how many seconds to wait before timing out a webhook.
    - `record_type` string
  - `meta` PaginationMeta
    - `total_pages` integer, required
    - `total_results` integer
    - `page_number` integer, required
    - `page_size` integer

## Other responses

- `4XX` — Unexpected error

---

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