DYdyte-io
Sessions

Fetch participants list of a session

Changed on

Returns a list of participants for the given session ID.

get/sessions/{session_id}/participants

Request

  • Base URL
    https://api.dyte.io/v2
  • Auth
    HTTP basic

Path parameters

session_idstring required

ID of the session

Query parameters

searchstring

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

page_nonumber

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

per_pagenumber

Number of results per page

sort_order'ASC' | 'DESC'
sort_by'joinedAt' | 'duration'
include_peer_eventsboolean

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

view'raw' | 'consolidated'

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.

Response

Get participants list of a particular session

successboolean

Changes

  • v2cb67ff854c71Revision changes
    • breaking

      added the new path request parameter session_id

    • info

      the endpoint scheme security Authorization was added to the API

  • v268b9e665bfccRevision changes
    • warning

      deleted the path request parameter session_id

    • info

      the endpoint scheme security Authorization was removed from the API