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
Query Parameters
These parameters control the users sub-list, not the room itself:
Number of users to return. Maximum 100.
Case-insensitive partial match on user name or ID.
ISO date string. Only return users created at or after this date.
ISO date string. Only return users created at or before this date.
Response
Total number of users in the room.
The limit used for the users list.
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}"
{
"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
}