v1

latestOpenAPI 3.1.02026-07-26102934.7 KB

rooms

List rooms

Returns a paginated list of rooms accessible to the authenticated user. Rooms group related meetings together.

get/rooms

Query parameters

idstring[] nullable

Filter by one or more room IDs.

scope'owned' | 'shared' | 'all'

Filter by ownership scope.

all — all accessible rooms
owned — rooms you own
shared — rooms shared with you

searchstring nullable

Search by room title.

expandRoomExpand[] nullable

Expand related resources inline. Supported values: documents, meetings.

cursorstring nullable

Pagination cursor from a previous response's next_cursor.

limitinteger

Number of results per page (1–100).

Response

A paginated list of rooms.

next_cursorstring nullable required

Cursor for the next page. null if no more results.

has_moreboolean required

Whether more results exist beyond this page.

Example response

{
  "data": [
    {
      "id": "room_abc123",
      "title": "Engineering standups",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-15T10:30:00Z",
      "meeting_count": 42,
      "documents": [
        {
          "id": "doc_abc123",
          "title": "Meeting summary",
          "created_at": "2025-01-15T10:35:00Z"
        }
      ],
      "meetings": [
        {
          "id": "mtg_abc123",
          "title": "Weekly standup",
          "start_time": "2025-01-15T10:00:00Z",
          "duration": 1800
        }
      ]
    }
  ]
}