--- title: Fetch participants list of a session --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Realtime Kit](https://developers.cloudflare.com/api/go/resources/realtime_kit) [Sessions](https://developers.cloudflare.com/api/go/resources/realtime_kit/subresources/sessions) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Fetch participants list of a session client.RealtimeKit.Sessions.GetSessionParticipants(ctx, appID, sessionID, params) (\*[SessionGetSessionParticipantsResponse](), error) GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/participants Returns a list of participants for the given session ID. ##### Security API Token The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). **Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY` ##### Accepted Permissions (at least one required) `Realtime Admin``Realtime` ##### ParametersExpand Collapse appID string The app identifier tag. [Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(method)%20get_session_participants%20%3E%20(params)%20default%20%3E%20(param)%20app_id%20%3E%20(schema)>) sessionID string formatuuid [Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(method)%20get_session_participants%20%3E%20(params)%20default%20%3E%20(param)%20session_id%20%3E%20(schema)>)
params SessionGetSessionParticipantsParams AccountID param.Field\[string] Path param: The account identifier tag. maxLength32 Link to this property IncludePeerEvents param.Field\[bool]Optional Query param: if true, response includes all the peer events of participants. Link to this property PageNo param.Field\[float64]Optional Query param: The page number from which you want your page search results to be displayed. minimum0 Link to this property PerPage param.Field\[int64]Optional Query param: Number of results per page. maximum200 minimum1 Link to this property Search param.Field\[string]Optional Query param: The search query string. You can search using participant ID, custom participant ID, or display name. Link to this property
SortBy param.Field\[SessionGetSessionParticipantsParamsSortBy]Optional Query param const SessionGetSessionParticipantsParamsSortByJoinedAt SessionGetSessionParticipantsParamsSortBy = "joinedAt" Link to this property const SessionGetSessionParticipantsParamsSortByDuration SessionGetSessionParticipantsParamsSortBy = "duration" Link to this property
Link to this property
SortOrder param.Field\[SessionGetSessionParticipantsParamsSortOrder]Optional Query param const SessionGetSessionParticipantsParamsSortOrderAsc SessionGetSessionParticipantsParamsSortOrder = "ASC" Link to this property const SessionGetSessionParticipantsParamsSortOrderDesc SessionGetSessionParticipantsParamsSortOrder = "DESC" Link to this property
Link to this property
View param.Field\[SessionGetSessionParticipantsParamsView]Optional Query param: 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. const SessionGetSessionParticipantsParamsViewRaw SessionGetSessionParticipantsParamsView = "raw" Link to this property const SessionGetSessionParticipantsParamsViewConsolidated SessionGetSessionParticipantsParamsView = "consolidated" Link to this property
Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(method)%20get_session_participants%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type SessionGetSessionParticipantsResponse struct{…}
Data SessionGetSessionParticipantsResponseDataOptional
Participants \[]SessionGetSessionParticipantsResponseDataParticipantOptional ID stringOptional Participant ID. This maps to the corresponding peerId. Link to this property CreatedAt stringOptional timestamp when this participant was created. Link to this property CustomParticipantID stringOptional ID passed by client to create this participant. Link to this property DisplayName stringOptional Display name of participant when joining the session. Link to this property Duration float64Optional number of minutes for which the participant was in the session. Link to this property JoinedAt stringOptional timestamp at which participant joined the session. Link to this property LeftAt stringOptional timestamp at which participant left the session. Link to this property
PeerEvents \[]SessionGetSessionParticipantsResponseDataParticipantsPeerEventOptional Connection lifecycle events for the participant’s peer. Only included when include_peer_events is true. ID stringOptional ID of the peer event. Link to this property CreatedAt stringOptional Timestamp when this peer event was created. Link to this property
EventName SessionGetSessionParticipantsResponseDataParticipantsPeerEventsEventNameOptional Name of the peer event. One of the following: const SessionGetSessionParticipantsResponseDataParticipantsPeerEventsEventNamePeerCreated SessionGetSessionParticipantsResponseDataParticipantsPeerEventsEventName = "PEER\_CREATED" Link to this property const SessionGetSessionParticipantsResponseDataParticipantsPeerEventsEventNamePeerJoining SessionGetSessionParticipantsResponseDataParticipantsPeerEventsEventName = "PEER\_JOINING" Link to this property const SessionGetSessionParticipantsResponseDataParticipantsPeerEventsEventNamePeerLeaving SessionGetSessionParticipantsResponseDataParticipantsPeerEventsEventName = "PEER\_LEAVING" Link to this property
Link to this property MinutesConsumed float64Optional Minutes consumed attributed to this event. Link to this property ParticipantID stringOptional ID of the participant this event belongs to. Link to this property PeerID stringOptional Peer ID this event belongs to. Link to this property
PresetViewType SessionGetSessionParticipantsResponseDataParticipantsPeerEventsPresetViewTypeOptional View type of the preset associated with the peer. One of the following: const SessionGetSessionParticipantsResponseDataParticipantsPeerEventsPresetViewTypeGroupCall SessionGetSessionParticipantsResponseDataParticipantsPeerEventsPresetViewType = "GROUP\_CALL" Link to this property const SessionGetSessionParticipantsResponseDataParticipantsPeerEventsPresetViewTypeWebinar SessionGetSessionParticipantsResponseDataParticipantsPeerEventsPresetViewType = "WEBINAR" Link to this property const SessionGetSessionParticipantsResponseDataParticipantsPeerEventsPresetViewTypeAudioRoom SessionGetSessionParticipantsResponseDataParticipantsPeerEventsPresetViewType = "AUDIO\_ROOM" Link to this property const SessionGetSessionParticipantsResponseDataParticipantsPeerEventsPresetViewTypeLivestream SessionGetSessionParticipantsResponseDataParticipantsPeerEventsPresetViewType = "LIVESTREAM" Link to this property const SessionGetSessionParticipantsResponseDataParticipantsPeerEventsPresetViewTypeChat SessionGetSessionParticipantsResponseDataParticipantsPeerEventsPresetViewType = "CHAT" Link to this property
Link to this property SessionID stringOptional ID of the session this event belongs to. Link to this property SocketSessionID stringOptional ID of the socket session associated with this event. Link to this property UpdatedAt stringOptional Timestamp when this peer event was last updated. Link to this property
Link to this property PresetName stringOptional Name of the preset associated with the participant. Link to this property UpdatedAt stringOptional timestamp when this participant’s data was last updated. Link to this property UserID stringOptional User id for this participant. Link to this property
Link to this property
Link to this property Success boolOptional Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20SessionGetSessionParticipantsResponse%20%3E%20(schema)>) ### Fetch participants list of a session Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/realtime_kit" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.RealtimeKit.Sessions.GetSessionParticipants( context.TODO(), "14a396e7-ca44-4937-bf1f-050a69118543", "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", realtime_kit.SessionGetSessionParticipantsParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) } ``` 200 example 200 example ``` { "data": { "paging": { "end_offset": 2, "start_offset": 1, "total_count": 123 }, "participants": [ { "created_at": "2023-02-01T10:51:08.039Z", "custom_participant_id": "83qi0i", "display_name": "Mark", "duration": 5.8097, "id": "005f4e0c-4d08-4d4e-a391-a76be75cd296", "joined_at": "2023-02-01T10:51:08.03Z", "left_at": "2023-02-01T10:56:56.612Z", "preset_name": "webinar_participant", "updated_at": "2023-02-01T10:56:56.618Z", "user_id": "0a08343d-a9dc-45f0-9feb-6a64afcc4f81" }, { "created_at": "2023-02-01T10:50:36.853Z", "custom_participant_id": "3uggr", "display_name": "Henry", "duration": 6.9263, "id": "51fdf95f-d893-471a-922b-7db7adb14453", "joined_at": "2023-02-01T10:50:36.846Z\"", "left_at": "2023-02-01T10:57:32.424Z", "preset_name": "webinar_participant", "updated_at": "2023-02-01T10:57:32.431Z", "user_id": "85e7f0fd-7c16-45e9-9d68-f17ef007c4eb" } ] }, "success": true } ``` ``` { "data": { "paging": { "end_offset": 2, "start_offset": 1, "total_count": 123 }, "participants": [ { "created_at": "2023-02-01T10:51:08.039Z", "custom_participant_id": "83qi0i", "display_name": "Mark", "duration": 5.8097, "id": "005f4e0c-4d08-4d4e-a391-a76be75cd296", "joined_at": "2023-02-01T10:51:08.03Z", "left_at": "2023-02-01T10:56:56.612Z", "peer_events": [ { "created_at": "2023-02-01T10:51:50.786Z", "event_name": "PEER_JOINING", "id": "94af3bac-f30b-40b9-ab45-4b9e6eff191a", "peer_id": "79d87ca5-7e47-452a-b3c1-b6842ad84bf5", "updated_at": "2023-02-01T10:51:50.792Z" }, { "created_at": "2023-02-01T10:56:50.786Z", "event_name": "PEER_LEAVING", "id": "94af3bac-f30b-40b9-ab45-4b9e6eff191b", "peer_id": "79d87ca5-7e47-452a-b3c1-b6842ad84bf5", "updated_at": "2023-02-01T10:56:50.792Z" } ], "preset_name": "webinar_participant", "updated_at": "2023-02-01T10:56:56.618Z", "user_id": "0a08343d-a9dc-45f0-9feb-6a64afcc4f81" }, { "created_at": "2023-02-01T10:50:36.853Z", "custom_participant_id": "3uggr", "display_name": "Henry", "duration": 6.9263, "id": "51fdf95f-d893-471a-922b-7db7adb14453", "joined_at": "2023-02-01T10:50:36.846Z\"", "left_at": "2023-02-01T10:57:32.424Z", "peer_events": [ { "created_at": "2023-02-01T10:51:50.786Z", "event_name": "PEER_JOINING", "id": "94af3bac-f30b-40b9-ab45-4b9e6eff191a", "peer_id": "51fdf95f-d893-471a-922b-7db7adb14453", "updated_at": "2023-02-01T10:51:50.792Z" }, { "created_at": "2023-02-01T10:56:50.786Z", "event_name": "PEER_LEAVING", "id": "94af3bac-f30b-40b9-ab45-4b9e6eff191b", "peer_id": "51fdf95f-d893-471a-922b-7db7adb14453", "updated_at": "2023-02-01T10:56:50.792Z" } ], "preset_name": "webinar_participant", "updated_at": "2023-02-01T10:57:32.431Z", "user_id": "85e7f0fd-7c16-45e9-9d68-f17ef007c4eb" } ] }, "success": true } ``` ##### Returns Examples 200 example 200 example ``` { "data": { "paging": { "end_offset": 2, "start_offset": 1, "total_count": 123 }, "participants": [ { "created_at": "2023-02-01T10:51:08.039Z", "custom_participant_id": "83qi0i", "display_name": "Mark", "duration": 5.8097, "id": "005f4e0c-4d08-4d4e-a391-a76be75cd296", "joined_at": "2023-02-01T10:51:08.03Z", "left_at": "2023-02-01T10:56:56.612Z", "preset_name": "webinar_participant", "updated_at": "2023-02-01T10:56:56.618Z", "user_id": "0a08343d-a9dc-45f0-9feb-6a64afcc4f81" }, { "created_at": "2023-02-01T10:50:36.853Z", "custom_participant_id": "3uggr", "display_name": "Henry", "duration": 6.9263, "id": "51fdf95f-d893-471a-922b-7db7adb14453", "joined_at": "2023-02-01T10:50:36.846Z\"", "left_at": "2023-02-01T10:57:32.424Z", "preset_name": "webinar_participant", "updated_at": "2023-02-01T10:57:32.431Z", "user_id": "85e7f0fd-7c16-45e9-9d68-f17ef007c4eb" } ] }, "success": true } ``` ``` { "data": { "paging": { "end_offset": 2, "start_offset": 1, "total_count": 123 }, "participants": [ { "created_at": "2023-02-01T10:51:08.039Z", "custom_participant_id": "83qi0i", "display_name": "Mark", "duration": 5.8097, "id": "005f4e0c-4d08-4d4e-a391-a76be75cd296", "joined_at": "2023-02-01T10:51:08.03Z", "left_at": "2023-02-01T10:56:56.612Z", "peer_events": [ { "created_at": "2023-02-01T10:51:50.786Z", "event_name": "PEER_JOINING", "id": "94af3bac-f30b-40b9-ab45-4b9e6eff191a", "peer_id": "79d87ca5-7e47-452a-b3c1-b6842ad84bf5", "updated_at": "2023-02-01T10:51:50.792Z" }, { "created_at": "2023-02-01T10:56:50.786Z", "event_name": "PEER_LEAVING", "id": "94af3bac-f30b-40b9-ab45-4b9e6eff191b", "peer_id": "79d87ca5-7e47-452a-b3c1-b6842ad84bf5", "updated_at": "2023-02-01T10:56:50.792Z" } ], "preset_name": "webinar_participant", "updated_at": "2023-02-01T10:56:56.618Z", "user_id": "0a08343d-a9dc-45f0-9feb-6a64afcc4f81" }, { "created_at": "2023-02-01T10:50:36.853Z", "custom_participant_id": "3uggr", "display_name": "Henry", "duration": 6.9263, "id": "51fdf95f-d893-471a-922b-7db7adb14453", "joined_at": "2023-02-01T10:50:36.846Z\"", "left_at": "2023-02-01T10:57:32.424Z", "peer_events": [ { "created_at": "2023-02-01T10:51:50.786Z", "event_name": "PEER_JOINING", "id": "94af3bac-f30b-40b9-ab45-4b9e6eff191a", "peer_id": "51fdf95f-d893-471a-922b-7db7adb14453", "updated_at": "2023-02-01T10:51:50.792Z" }, { "created_at": "2023-02-01T10:56:50.786Z", "event_name": "PEER_LEAVING", "id": "94af3bac-f30b-40b9-ab45-4b9e6eff191b", "peer_id": "51fdf95f-d893-471a-922b-7db7adb14453", "updated_at": "2023-02-01T10:56:50.792Z" } ], "preset_name": "webinar_participant", "updated_at": "2023-02-01T10:57:32.431Z", "user_id": "85e7f0fd-7c16-45e9-9d68-f17ef007c4eb" } ] }, "success": true } ```