> ## 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 by Custom ID

> Look up a room using its custom identifier.

Retrieve room details by the optional `custom_id` set during room creation, instead of the internal UUID.

## Endpoint

```
GET /v1/accounts/:accountId/rooms/custom/:customId
```

## Authentication

**Bearer token** required.

## Path Parameters

<ParamField path="customId" type="string" required>
  The custom identifier assigned when the room was created.
</ParamField>

## Query Parameters

Supports the same user pagination and filtering parameters as [Get Room](/api-reference/rooms/get-room):

<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

Returns the same response format as [Get Room](/api-reference/rooms/get-room).

## Example

<CodeGroup>
  ```bash curl theme={null}
  curl "https://api.collab-kit.com/v1/accounts/${ACCOUNT_ID}/rooms/custom/my-room-1" \
    -H "Authorization: Bearer ${TOKEN}"
  ```

  ```typescript JavaScript theme={null}
  const res = await fetch(
    `https://api.collab-kit.com/v1/accounts/${accountId}/rooms/custom/my-room-1`,
    { headers: { 'Authorization': `Bearer ${token}` } }
  );
  const { data } = await res.json();
  console.log(data.room, data.users);
  ```
</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": [ ... ],
    "usersTotal": 5,
    "limit": 50,
    "offset": 0
  },
  "error": null
}
```

<Note>
  If no room matches the given `customId` within your organization, the API returns a `404 NOT_FOUND` error.
</Note>