> ## Documentation Index
> Fetch the complete documentation index at: https://docs.collab-kit.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Room

> Get room details including its users.

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

<ParamField path="roomId" type="string" required>
  The room's unique ID.
</ParamField>

## Query Parameters

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

<ParamField query="limit" type="number" default="50">
  Number of users to return. Maximum `100`.
</ParamField>

<ParamField query="offset" type="number" default="0">
  Number of users to skip.
</ParamField>

<ParamField query="search" type="string">
  Case-insensitive partial match on user name or ID.
</ParamField>

<ParamField query="from" type="string">
  ISO date string. Only return users created at or after this date.
</ParamField>

<ParamField query="to" type="string">
  ISO date string. Only return users created at or before this date.
</ParamField>

## Response

<ResponseField name="room" type="CollabKitRoom">
  The room object with merged analytics. See [`CollabKitRoom`](/types/core#collabkitroom).
</ResponseField>

<ResponseField name="users" type="CollabKitUser[]">
  Paginated list of users in this room. See [`CollabKitUser`](/types/core#collabkituser).
</ResponseField>

<ResponseField name="usersTotal" type="number">
  Total number of users in the room.
</ResponseField>

<ResponseField name="limit" type="number">
  The limit used for the users list.
</ResponseField>

<ResponseField name="offset" type="number">
  The offset used for the users list.
</ResponseField>

## Example

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

  ```typescript JavaScript theme={null}
  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();
  ```
</CodeGroup>

```json Response theme={null}
{
  "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
}
```