Get Room

Retrieve details for a specific room, including a paginated list of its users.

Endpoint

GET /v1/accounts/:accountId/rooms/:roomId

Authentication

Bearer token required.

Path Parameters

roomId

string

required

The room’s unique ID.

Query Parameters

These parameters control the users sub-list, not the room itself:

limit

number

default:"50"

Number of users to return. Maximum 100.

offset

number

default:"0"

Number of users to skip.

string

Case-insensitive partial match on user name or ID.

from

string

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

string

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

Response

room

CollabKitRoom

The room object with merged analytics. See CollabKitRoom.

users

CollabKitUser[]

Paginated list of users in this room. See CollabKitUser.

usersTotal

number

Total number of users in the room.

limit

number

The limit used for the users list.

offset

number

The offset used for the users list.

Example

curl "https://api.collab-kit.com/v1/accounts/${ACCOUNT_ID}/rooms/c3003c93-60cf-4184-b85f-20be14d26dac?limit=10" \
  -H "Authorization: Bearer ${TOKEN}"

const roomId = 'c3003c93-60cf-4184-b85f-20be14d26dac';
const res = await fetch(`https://api.collab-kit.com/v1/accounts/${accountId}/rooms/${roomId}?limit=10`, {
  headers: { 'Authorization': `Bearer ${token}` },
});
const { data } = await res.json();

Response

{
  "type": "response",
  "success": true,
  "description": "Room retrieved",
  "data": {
    "room": {
      "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
    },
    "users": [
      {
        "id": "f47ac10b-58cc-4372-...",
        "room_id": "c3003c93-...",
        "name": "Alice",
        "profile_picture": "https://example.com/alice.png",
        "custom_id": "alice-001",
        "status": "online",
        "created_at": "2026-05-29T10:05:00.000Z",
        "joined_at": "2026-05-29T10:06:00.000Z"
      }
    ],
    "usersTotal": 5,
    "limit": 10,
    "offset": 0
  },
  "error": null
}

Overview

Rooms

Users

Storage

Webhooks

Workflows

Endpoint

Authentication

Path Parameters

Query Parameters

Response

Example

​Endpoint

​Authentication

​Path Parameters

​Query Parameters

​Response

​Example

Endpoint

Authentication

Path Parameters

Query Parameters

Response

Example