Skip to main content
Get a list of all active participants currently in a meeting room. Available for both authenticated and guest users.

Endpoints

By Room ID

GET /rooms/:id/participants
Requires authentication. Returns all active participants for a room by its database ID.

By Room Code

GET /rooms/code/:code/participants
Public endpoint. Returns all active participants for a room by its meeting code (xxx-xxx-xxx format).

Authentication

  • /rooms/:id/participants - Requires JWT authentication
  • /rooms/code/:code/participants - No authentication required (public)

Path Parameters

id
string
The room’s unique identifier (CUID) - for ID endpoint
code
string
The room’s meeting code in xxx-xxx-xxx format - for code endpoint

Response

Returns an array of active participant objects.
participants
array
Array of participant objects currently in the room

Example Request

By Room ID (Authenticated)

cURL
curl -X GET https://api.neuronmeet.com/rooms/clh3x2k5g0001l408xyz12345/participants \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

By Room Code (Public)

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

Example Response

[
  {
    "id": "clh3x3k5g0002l408xyz67890",
    "userId": "clh3x2k5g0001l408xyz12345",
    "guestName": null,
    "isActive": true,
    "isHost": true,
    "joinedAt": "2024-03-03T10:00:00.000Z",
    "user": {
      "name": "Alex Johnson",
      "displayName": "Alex J."
    }
  },
  {
    "id": "clh3x4k5g0003l408xyz11111",
    "userId": null,
    "guestName": "Guest User",
    "isActive": true,
    "isHost": false,
    "joinedAt": "2024-03-03T10:05:00.000Z",
    "user": null
  },
  {
    "id": "clh3x5k5g0004l408xyz22222",
    "userId": "clh3x6k5g0005l408xyz33333",
    "guestName": null,
    "isActive": true,
    "isHost": false,
    "joinedAt": "2024-03-03T10:10:00.000Z",
    "user": {
      "name": "Sarah Williams",
      "displayName": "Sarah W."
    }
  }
]

Error Responses

404 Not Found

Room does not exist.
{
  "statusCode": 404,
  "message": "Room not found"
}

401 Unauthorized

Missing or invalid JWT token (for ID endpoint only).
{
  "statusCode": 401,
  "message": "Unauthorized"
}

Use Cases

  • Display participant list in meeting UI
  • Show participant count before joining
  • Update participant roster in real-time (combine with WebSocket events)
  • Check if room has active participants
  • Identify room host for UI badges

Real-Time Updates

For real-time participant updates during meetings, use WebSocket events in combination with this endpoint:
  • join-room - Initial participant list on joining
  • user-joined - New participant joined
  • user-left - Participant left the room
See WebRTC Signaling Events for more details.

Build docs developers (and LLMs) love