Skip to main content
GET
List rooms

Authorizations

Authorization
string
header
required

API token from your Timeless dashboard.

Query Parameters

id
string[] | null

Filter by one or more room IDs.

scope
enum<string>
default:all

Filter by ownership scope.

  • all — all accessible rooms
  • owned — rooms you own
  • shared — rooms shared with you
Available options:
owned,
shared,
all
search
string | null

Search by room title.

expand
enum<string>[] | null

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

Available options:
documents,
meetings
cursor
string | null

Pagination cursor from a previous response's next_cursor.

limit
integer
default:25

Number of results per page (1–100).

Required range: 1 <= x <= 100

Response

A paginated list of rooms.

data
Room · object[]
required
next_cursor
string | null
required

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

has_more
boolean
required

Whether more results exist beyond this page.