Skip to main content
GET
/
rooms
/
code
/
:code
Get Room
curl --request GET \
  --url https://api.example.com/rooms/code/:code
{
  "401": {},
  "404": {},
  "id": "<string>",
  "code": "<string>",
  "name": "<string>",
  "isActive": true,
  "isLocked": true,
  "host": {
    "id": "<string>",
    "displayName": "<string>",
    "avatarUrl": "<string>"
  },
  "settings": {
    "waitingRoom": true
  }
}
Retrieve room information by room code. This endpoint is publicly accessible and returns limited information for non-authenticated requests.

Parameters

code
string
required
The unique room code in format xxx-xxx-xxx (e.g., “abc-def-ghi”)

Response

Returns room information with limited details for public access.
id
string
required
Unique identifier for the room
code
string
required
The room’s unique code
name
string
required
Name of the room
isActive
boolean
required
Whether the room is currently active
isLocked
boolean
required
Whether the room is locked (prevents new participants from joining)
host
object
required
Information about the room host
id
string
required
Host user ID
displayName
string
required
Host display name
avatarUrl
string
URL to host’s avatar image
settings
object
Limited settings information (only waitingRoom status is exposed publicly)
waitingRoom
boolean
required
Whether waiting room is enabled

Example Request

curl https://api.neuronmeet.com/rooms/code/abc-def-ghi

Example Response

{
  "id": "clx1a2b3c4d5e6f7g8h9i0j",
  "code": "abc-def-ghi",
  "name": "Team Standup",
  "isActive": true,
  "isLocked": false,
  "host": {
    "id": "clx0a1b2c3d4e5f6g7h8i9j",
    "displayName": "John Doe",
    "avatarUrl": "https://example.com/avatar.jpg"
  },
  "settings": {
    "waitingRoom": true
  }
}

Get Room by ID (Authenticated)

For authenticated requests, you can also retrieve full room details by ID.

Endpoint

GET /rooms/:id

Authentication

Requires JWT authentication via Bearer token.

Parameters

id
string
required
The unique room ID

Response

Returns complete room object with all settings.

Example Request

curl https://api.neuronmeet.com/rooms/clx1a2b3c4d5e6f7g8h9i0j \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Example Response

{
  "id": "clx1a2b3c4d5e6f7g8h9i0j",
  "code": "abc-def-ghi",
  "name": "Team Standup",
  "hostId": "clx0a1b2c3d4e5f6g7h8i9j",
  "isActive": true,
  "isLocked": false,
  "startedAt": "2026-03-03T10:30:00.000Z",
  "endedAt": null,
  "createdAt": "2026-03-03T10:30:00.000Z",
  "updatedAt": "2026-03-03T10:30:00.000Z",
  "host": {
    "id": "clx0a1b2c3d4e5f6g7h8i9j",
    "displayName": "John Doe",
    "avatarUrl": "https://example.com/avatar.jpg"
  },
  "settings": {
    "id": "clx2a3b4c5d6e7f8g9h0i1j",
    "roomId": "clx1a2b3c4d5e6f7g8h9i0j",
    "allowChat": true,
    "allowScreenShare": true,
    "allowGuestAccess": true,
    "waitingRoom": true,
    "muteParticipantsOnJoin": false,
    "maxParticipants": 10
  }
}

Get Room Participants

Retrieve all active participants in a room.

Endpoint

GET /rooms/:id/participants
GET /rooms/code/:code/participants

Example Request

curl https://api.neuronmeet.com/rooms/code/abc-def-ghi/participants

Example Response

[
  {
    "id": "clx3a4b5c6d7e8f9g0h1i2j",
    "displayName": "John Doe",
    "avatarUrl": "https://example.com/avatar.jpg",
    "isHost": true
  },
  {
    "id": "clx4a5b6c7d8e9f0g1h2i3j",
    "displayName": "Jane Smith",
    "avatarUrl": null,
    "isHost": false
  }
]

Error Codes

404
error
Not Found - Room with the specified code or ID does not exist
{
  "statusCode": 404,
  "message": "Room not found"
}
401
error
Unauthorized - Missing or invalid JWT token (for authenticated endpoints only)

Build docs developers (and LLMs) love