List sessions

This API retrieves details of a list of sessions in your account.


curl --location --request GET 'https://api.100ms.live/v2/sessions' \
--header 'Authorization: Bearer <management_token>'

RESPONSE

Status: 200 OK


{
    "limit": 10,
    "data": [
        {
            "id": "631a0fa23e3d9fdb00832596",
            "room_id": "631a0f990e6ffae22efa610c",
            "customer_id": "627cdddff2e4e30487862ad1",
            "active": false,
            "peers": {
                "a24687bb-de68-4276-9758-e1efa5e7e4d8": {
                    "id": "a24687bb-de68-4276-9758-e1efa5e7e4d8",
                    "session_id": "631a0fa23e3d9fdb00832596",
                    "name": "asdas",
                    "role": "host",
                    "user_id": "Batch1-student1",
                    "joined_at": "2022-09-08T15:52:02.194Z",
                    "left_at": "2022-09-08T15:52:04.009Z"
                }
            },
            "created_at": "2022-09-08T15:52:02.197Z",
            "updated_at": "2022-09-08T15:52:04.015Z"
        },
        ......
        ......
        ......
        ......
        {
            "id": "63172c2d3e3d9fdb008322e1",
            "room_id": "627ce5b8f2e4e30487862adb",
            "customer_id": "627cdddff2e4e30487862ad1",
            "active": false,
            "peers": {
                "2d873b0a-c2c9-41dc-ac72-c6ea9b2f2cc3": {
                    "id": "2d873b0a-c2c9-41dc-ac72-c6ea9b2f2cc3",
                    "session_id": "63172c2d3e3d9fdb008322e1",
                    "name": "Nixon K",
                    "role": "backstage",
                    "user_id": "Batch1-student10",
                    "joined_at": "2022-09-06T11:17:01.816Z",
                    "left_at": "2022-09-06T11:17:03.643Z"
                }
            },
            "created_at": "2022-09-06T11:17:01.817Z",
            "updated_at": "2022-09-06T11:17:03.65Z"
        }
    ],
    "last": "63172c2d3e3d9fdb008322e1"
}

Allowed filters

Name	Type	Description	Required
active	`boolean`	Flag to fetch the list of active room sessions. `Default`: true, `Allowed values`: true, false	No
room_id	`string`	Fetch the list of sessions created in the room specified. Example: `627cda81ab4f3b56a077dc33`	No
after	`string`	Check for sessions started with a timestamp greater than or equal to "after" `Format`: YYYY-MM-DDTHH:mm:ss.sssZ.	No
before	`string`	Check for sessions started with a timestamp less than or equal to "after" `Format`: YYYY-MM-DDTHH:mm:ss.sssZ.	No
limit	`int`	Determines the number of session objects to be included in response. `Default`: 10, `Allowed values`: Min: 10, Max: 100	No
start	`string`	Determines the starting point. `last` field of the response can be used as start for the subsequent request. For example "63172c2d3e3d9fdb008322e1".	No

Retrieve a specific session Overview

Have a suggestion? Recommend changes ->