Docs
REST API v1

Read a participant

Read one participant in a room.

GET/v1/rooms/{roomId}/participants/{participantId}

Requirements

A secret API key with participants:read. Resources are restricted to the key's project and environment.

Path parameters

NameTypeRequired / defaultDescription
roomIdstringRequiredID of a room in the key's environment.
participantIdstringRequiredID of a participant in this room.

Example

Set RELAYRTC_API_URL to your API base including /v1, such as http://localhost:8082/v1.

Shell
curl -X GET "$RELAYRTC_API_URL/rooms/room_example/participants/participant_example" \
  -H "Authorization: Bearer $RELAYRTC_SECRET_KEY"

Response

200 with a participant object.

JSON
{
  "id": "participant_example",
  "roomId": "room_example",
  "externalId": null,
  "name": "Alice",
  "metadata": {},
  "role": "participant",
  "joinedAt": "2026-01-01T12:00:00.000Z",
  "leftAt": null
}

Errors

Invalid fields return 400. Invalid credentials return 401; a missing scope returns 403. A missing resource returns 404. See error responses.