Get participants on a channel

This endpoint enables you to get a list of all participants that are currently connected to a specific channel in a room.

How to use

You can use the following cURL to obtain a response from this endpoint:

curl --request GET \
  --url https://api.superviz.com/realtime/participants/CHANNEL_NAME \
  --header "client_id: ${YOUR CLIENT_ID}" \
  --header "secret: ${YOUR SECRET}"

HTTP Request

GET /realtime/participants/{channel_name}

In the request, you will need to send in the path following field:

Name	Description
channel	Required. The name of the channel.

Headers

When using this endpoint, you need to provide the API Key. The following headers are required:

Name	Description
client_id	Required. You need to use the Client ID to authenticate in this repository. You can retrieve your Client ID under the Dashboard > Developer > Keys.
secret	Required. You need to use the Secret Key to authenticate in this repository. You can create a new API Secret under our Dashboard > Developer > Keys.

Response

Status code 200 will indicate that the request was successful. The response will be a list in a JSON format, and include the following fields:

Name	Type	Description
participants	array	The list of currently connected participants. This value can be nullable, meaning that the event wasn't dispatched by a participant.
participants[].id	string	The ID of the participant.
participants[].name	string	The name of the participant.
participants[].connectionId	string	The current connection ID of the participant. This value can be nullable, meaning that the event wasn't dispatched by a participant.
participants[].timestamp	number	The timestamp when the participant connected to the room.
participants[].channel	string	The ID of the room the participant is connected to.

Example:

[
  {
    "id": "b38ygi",
    "name": "PARTICIPANT_NAME",
    "connectionId": "CONNECTION_ID",
    "timestamp": 1716815551683,
    "channel": "CHANNEL_NAME",
  }
]