List participants | RelayRTC Docs

Requirements

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

Name	Type	Required / default	Description
roomId	string	Required	ID of a room in the key's environment.

Name	Type	Required / default	Description
cursor	string	Optional	Opaque endCursor from the previous page.
limit	integer	50	From 1 to 100.
status	string	Optional	active or left.

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

curl -X GET "$RELAYRTC_API_URL/rooms/room_example/participants?limit=20&status=active" \
  -H "Authorization: Bearer $RELAYRTC_SECRET_KEY"

200 with nodes: Participant[] and pageInfo.

{
  "nodes": [],
  "pageInfo": {
    "endCursor": null,
    "hasNextPage": false
  }
}

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