GET /accounts/{account_id}/realtimekit/sessions/{session_id}/participants

Returns a list of participants for the given session ID.

Servers

Path parameters

Name Type Required Description
session_id String Yes

ID of the session

account_id String Yes

Query parameters

Name Type Required Description
sort_order String No

Valid values:

  • "DESC"
  • "ASC"
per_page Number No

Number of results per page

search String No

The search query string. You can search using the meeting ID or title.

page_no Number No

The page number from which you want your page search results to be displayed.

include_peer_events Boolean No

if true, response includes all the peer events of participants.

Default value: false

view String No

In breakout room sessions, the view parameter can be set to raw for session specific duration for participants or consolidated to accumulate breakout room durations.

Valid values:

  • "consolidated"
  • "raw"

Default value: "raw"

sort_by String No

Valid values:

  • "duration"
  • "joinedAt"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.