List Rooms

Retrieve a paginated list of rooms in your organization.

Endpoint

GET /v1/accounts/:accountId/rooms

Authentication

Bearer token required.

Query Parameters

number

default:"50"

Number of rooms to return. Maximum 100.

number

default:"0"

Number of rooms to skip for pagination.

string

Case-insensitive partial match on room name.

string

ISO date string. Only return rooms created at or after this date.

string

ISO date string. Only return rooms created at or before this date.

Response

CollabKitRoom[]

Array of room objects.

number

Total number of rooms matching the query (for pagination).

number

The limit used in this request.

number

The offset used in this request.

Example

# List first 10 rooms
curl "https://api.collab-kit.com/v1/accounts/${ACCOUNT_ID}/rooms?limit=10" \
  -H "Authorization: Bearer ${TOKEN}"

# Search by name
curl "https://api.collab-kit.com/v1/accounts/${ACCOUNT_ID}/rooms?search=whiteboard" \
  -H "Authorization: Bearer ${TOKEN}"

# Filter by date range
curl "https://api.collab-kit.com/v1/accounts/${ACCOUNT_ID}/rooms?from=2026-01-01&to=2026-06-01" \
  -H "Authorization: Bearer ${TOKEN}"

const res = await fetch(`https://api.collab-kit.com/v1/accounts/${accountId}/rooms?limit=10`, {
  headers: { 'Authorization': `Bearer ${token}` },
});
const { data } = await res.json();
console.log(data.rooms, data.total);

Response

{
  "type": "response",
  "success": true,
  "description": "Rooms retrieved",
  "data": {
    "rooms": [
      {
        "id": "c3003c93-60cf-4184-...",
        "account_id": "a1b2c3d4-...",
        "name": "whiteboard/room-one",
        "custom_id": "my-room-1",
        "created_at": "2026-05-29T10:00:00.000Z",
        "state": "active",
        "duration_seconds": 3600,
        "active_participants": 2,
        "total_users_created": 5
      }
    ],
    "total": 1,
    "limit": 10,
    "offset": 0
  },
  "error": null
}

Overview

Rooms

Users

Storage

Webhooks

Workflows

Endpoint

Authentication

Query Parameters

Response

Example

​Endpoint

​Authentication

​Query Parameters

​Response

​Example

Endpoint

Authentication

Query Parameters

Response

Example