latestOpenAPI 3.0.02026-08-1027587.8 KB

3d9aec0774ff

Get participants

Gets a list of participants, by either a given session id or external id.

get/insights/participants

Query parameters

session ID. Either roomSessionId or externalId is required.

an externalId that was originally passed in query params by the participant when joining. Either roomSessionId or externalId is required.

Sort results by a field. Accepted values are joinedAt and leftAt. Accepted sort values are asc and desc.

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request.

limitinteger

Example:30

Limit the number of results.

Response

Array of sorted sessions participants with insights.

cursorstring

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request. If there are no more results, the value returned is null.

Example response

{
  "results": [
    {
      "roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
      "participantId": "/4b3bd908-cb88-11ec-9d64-0242ac120002",
      "userId": "32ba120a-a691-4e8e-aec3-a610239271de",
      "roleName": "granted_visited",
      "displayName": "John Doe",
      "joinedAt": "2025-01-01T00:00:00.000Z",
      "leftAt": "2025-01-01T01:00:00.000Z",
      "rating": 5,
      "tags": [
        "audio-quality",
        "video-quality"
      ],
      "comment": "Great call quality!"
    }
  ]
}