--- title: Fetch participants list of a session --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Realtime Kit](https://developers.cloudflare.com/api/python/resources/realtime_kit) [Sessions](https://developers.cloudflare.com/api/python/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 realtime\_kit.sessions.get\_session\_participants(strsession\_id, SessionGetSessionParticipantsParams\*\*kwargs) -> [SessionGetSessionParticipantsResponse]() 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 account\_id: str The account identifier tag. maxLength32 [Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(method)%20get_session_participants%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) app\_id: str 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)>) session\_id: str 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)>) include\_peer\_events: Optional\[[bool]()] if true, response includes all the peer events of participants. [Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(method)%20get_session_participants%20%3E%20(params)%20default%20%3E%20(param)%20include_peer_events%20%3E%20(schema)>) page\_no: Optional\[float] The page number from which you want your page search results to be displayed. minimum0 [Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(method)%20get_session_participants%20%3E%20(params)%20default%20%3E%20(param)%20page_no%20%3E%20(schema)>) per\_page: Optional\[int] Number of results per page. maximum200 minimum1 [Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(method)%20get_session_participants%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>) search: Optional\[str] The search query string. You can search using participant ID, custom participant ID, or display name. [Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(method)%20get_session_participants%20%3E%20(params)%20default%20%3E%20(param)%20search%20%3E%20(schema)>)
sort\_by: Optional\[Literal\["joinedAt", "duration"]] One of the following: "joinedAt" Link to this property "duration" Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(method)%20get_session_participants%20%3E%20(params)%20default%20%3E%20(param)%20sort_by%20%3E%20(schema)>)
sort\_order: Optional\[Literal\["ASC", "DESC"]] One of the following: "ASC" Link to this property "DESC" Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(method)%20get_session_participants%20%3E%20(params)%20default%20%3E%20(param)%20sort_order%20%3E%20(schema)>)
view: Optional\[Literal\["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. One of the following: "raw" Link to this property "consolidated" Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(method)%20get_session_participants%20%3E%20(params)%20default%20%3E%20(param)%20view%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class SessionGetSessionParticipantsResponse: …
data: Optional\[Data]
participants: Optional\[List\[DataParticipant]] id: Optional\[str] Participant ID. This maps to the corresponding peerId. Link to this property created\_at: Optional\[str] timestamp when this participant was created. Link to this property custom\_participant\_id: Optional\[str] ID passed by client to create this participant. Link to this property display\_name: Optional\[str] Display name of participant when joining the session. Link to this property duration: Optional\[float] number of minutes for which the participant was in the session. Link to this property joined\_at: Optional\[str] timestamp at which participant joined the session. Link to this property left\_at: Optional\[str] timestamp at which participant left the session. Link to this property
peer\_events: Optional\[List\[DataParticipantPeerEvent]] Connection lifecycle events for the participant’s peer. Only included when include_peer_events is true. id: Optional\[str] ID of the peer event. Link to this property created\_at: Optional\[str] Timestamp when this peer event was created. Link to this property
event\_name: Optional\[Literal\["PEER\_CREATED", "PEER\_JOINING", "PEER\_LEAVING"]] Name of the peer event. One of the following: "PEER\_CREATED" Link to this property "PEER\_JOINING" Link to this property "PEER\_LEAVING" Link to this property
Link to this property minutes\_consumed: Optional\[float] Minutes consumed attributed to this event. Link to this property participant\_id: Optional\[str] ID of the participant this event belongs to. Link to this property peer\_id: Optional\[str] Peer ID this event belongs to. Link to this property
preset\_view\_type: Optional\[Literal\["GROUP\_CALL", "WEBINAR", "AUDIO\_ROOM", 2 more]] View type of the preset associated with the peer. One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property "CHAT" Link to this property
Link to this property session\_id: Optional\[str] ID of the session this event belongs to. Link to this property socket\_session\_id: Optional\[str] ID of the socket session associated with this event. Link to this property updated\_at: Optional\[str] Timestamp when this peer event was last updated. Link to this property
Link to this property preset\_name: Optional\[str] Name of the preset associated with the participant. Link to this property updated\_at: Optional\[str] timestamp when this participant’s data was last updated. Link to this property user\_id: Optional\[str] User id for this participant. Link to this property
Link to this property
Link to this property success: Optional\[bool] Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_participants_response%20%3E%20(schema)>) ### Fetch participants list of a session Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) response = client.realtime_kit.sessions.get_session_participants( session_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", app_id="14a396e7-ca44-4937-bf1f-050a69118543", ) print(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 } ```