📚Searching Sessions

This step shows to how to filter sessions with PerculusAPI.

Parameter	Type	Description
session_id	string	Session's GUID
name	string	Session's name
description	string	Session's description
tags	string	A comma separated list of tags
duration	integer	Session duration in minutes.
begin_date	string	Beginning date to filter by start date of the session
end_date	string	Ending date to filter by start date of the session
page_number	integer	Page size
page_size	integer	Page number

Below is an example of session filtering:

CURL

curl -L -X POST 'https://<DOMAIN>/xapi/v2/session/search' \
-H 'Content-Type: application/json' \
-d '{
    "begin_date": "2025-08-05",
    "end_date": "2025-09-05",
    "page_number": 1,
    "page_size": 10
}'

NodeJS

client.sessions.searchSessions({
        "begin_date": "2025-08-05",
        "end_date": "2025-09-05",
        "page_number": 1,
        "page_size": 10
    });

Example response:

[
    {
        "session_guid": "61E3D504-13EE-447F-9B36-6686C5C39FEB",
        "name": "Web Development 101",
        "description": "Let's learn the fundemental technologies used in Web Development",
        "tags": null,
        "start_date": "2025-08-05T12:00:00+03:00",
        "timezone": "Europe/Istanbul",
        "duration": 100,
        "lang": "en-US",
        "status": 1,
        "replay_status": 0,
        "options": {
            "allow_rating": true,
            "preparation_time": 15,
            "session_duration": 100,
            "chat": {
                "offMessageModule": false,
                "offGeneralMsging": false,
                "offGeneralMsgLimitForUser": false,
                "offSpecialMsging": false,
                "offSpecialMsgToAdmin": false,
                "offSpecialMsgToUser": false,
                "offNewMsgSound": false,
                "offClearForReplay": false,
                "onNewMsgSoundInAll": false,
                "onNewMsgNotifyInAll": false
            },
            "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": "2025-02-06T12:23:48.490759+00:00",
        "updating_date": "2025-02-06T13:25:07.50595+00:00"
    },
    {
        "session_guid": "9DDA6E4D-BE1B-460E-9AFB-86F6D07009D9",
        "name": "CS201",
        "description": "Let's learn the fundemental technologies used in Web Development",
        "tags": null,
        "start_date": "2025-08-05T12:00:00+03:00",
        "timezone": "Europe/Istanbul",
        "duration": 120,
        "lang": "en-US",
        "status": 1,
        "replay_status": 0,
        "options": {
            "allow_rating": true,
            "preparation_time": 15,
            "session_duration": 120,
            "chat": {
                "offMessageModule": false,
                "offGeneralMsging": false,
                "offGeneralMsgLimitForUser": false,
                "offSpecialMsging": false,
                "offSpecialMsgToAdmin": false,
                "offSpecialMsgToUser": false,
                "offNewMsgSound": false,
                "offClearForReplay": false,
                "onNewMsgSoundInAll": false,
                "onNewMsgNotifyInAll": false
            },
            "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": "2025-02-06T13:25:07.50595+00:00",
        "updating_date": "2025-02-06T13:25:07.50595+00:00"
    }
]