Selecting a Session

This step shows how you can pull the details of any of your sessions with PerculusAPI.

Example below shows the code block for how to retrieve the session details for a specific session:

CURL

curl -L -X GET  'https://<DOMAIN>/xapi/v2/session/:SESSION_GUID'

NodeJS

client.sessions.getSession("61E3D504-13EE-447F-9B36-6686C5C39FEB");

Below is an example response from the service:

{
    "session_guid": "3240EBC0-19EA-4208-97CC-BFF1F50562EB",
    "name": "Mechanical Keyboards 101",
    "description": null,
    "tags": null,
    "start_date": "2026-09-05T11:00:00+03:00",
    "timezone": "Europe/Istanbul",
    "duration": 20,
    "lang": "en-US",
    "status": 1,
    "replay_status": 0,
    "options": {
        "allow_rating": true,
        "preparation_time": 250,
        "session_duration": 20,
        "chat": {
            "offMessageModule": true,
            "offGeneralMsging": false,
            "offGeneralMsgLimitForUser": false,
            "offSpecialMsging": false,
            "offSpecialMsgToAdmin": false,
            "offSpecialMsgToUser": false,
            "offNewMsgSound": false,
            "offClearForReplay": false,
            "onNewMsgSoundInAll": false,
            "onNewMsgNotifyInAll": true
        },
        "duration": {
            "allowExtendTime": true,
            "useRemainingTime": false
        },
        "allow_users_stream_self_cam_mic": true,
        "hide_user_streams": false,
        "enable_attendance_check": true,
        "enable_simultaneous_interpretation": false,
        "enable_simultaneous_interpretation_for_users": false,
        "start_active": false,
        "return_url": "",
        "allow_reactions": true,
        "enable_recording_auto_start": null,
        "skip_approval_on_join": null,
        "enable_session_auto_start": null,
        "enable_session_auto_finish": null
    },
    "creation_date": "2024-09-27T18:04:35.546946+03:00",
    "updating_date": "2024-09-30T13:28:41.69466+03:00"
}