List

To list all participants you need to execute a GET request against the /participants endpoint.

Since potentially there could be thousands of participants, pagination is supported with limit, order and after arguments. Read about pagination to learn the details of it. By default maximum 100 participants will be returned in the response.

To list all participants for a concrete room execute a GET request against the /participants endpoint and add the room_id param. api/v1/participants?room_id=87a5d383-9e79-44ea-b382-686e430f4ecc

You can also use: api/v1/rooms/87a5d383-9e79-44ea-b382-686e430f4ecc/participants

To list all participants for a concrete session execute a GET request against the /participants endpoint and add the session_id param. api/v1/participants?session_id=09b9df70-7ce9-4f15-8ebb-55939024e72f

You can also use: api/v1/sessions/09b9df70-7ce9-4f15-8ebb-55939024e72f/participants

If you want to filter live participants (haven't left the room yet), then use the live parameter: api/v1/participants?live=true If you want to filter participants who left the room: api/v1/participants?live=false

Request (listing all participants)

cURL

curl --request GET \
  --url https://api.digitalsamba.com/api/v1/participants \
  --user YOUR_TEAM_ID:YOUR_DEVELOPER_KEY

Java

Response (200 OK)

{
    "total_count": 20000,
    "data": [
          {
            "id": "d4d68f3f-a087-4f41-88fc-b0414fa0c038",
            "external_id": null,
            "session_id": "09b9df70-7ce9-4f15-8ebb-55939024e72f",
            "room_id": "87a5d383-9e79-44ea-b382-686e430f4ecc",
            "room_external_id": null,
            "room_is_deleted": false,
            "name": "John Smith",
            "role": "moderator",
            "friendly_url": "EasySpanish",
            "join_time": "2024-03-27T09:21:24Z",
            "leave_time": "2024-03-27T09:32:29Z",
            "live": false
         },
         {
            "id": "29b7e989-48b7-4159-b72d-3f75ee5a82a9",
            "external_id": null,
            "session_id": "09b9df70-7ce9-4f15-8ebb-55939024e72f",
            "room_id": "87a5d383-9e79-44ea-b382-686e430f4ecc",
            "room_external_id": null,
            "room_is_deleted": false,
            "name": "Cillian Taylor",
            "role": "moderator",
            "friendly_url": "DailyEnglishLessons",
            "join_time": "2024-03-27T09:21:24Z",
            "leave_time": "2024-03-27T09:32:29Z",
            "live": false
         }
        ...............98 more participants...............
    ]
} 

The total_count is the total amount of participants that used the platform. It is NOT the amount of participants in the current page returned in the data array. In the above example you have 20000 participants in total, but in the data array there will be maximum 100 participants (the default limit argument value).