Sign in

v53

OpenAPI 3.1.0raw.githubusercontent.com2026-08-041,1941,9384.1 MB
Room Sessions

View a list of room sessions.

get/room_sessions

Query parameters

include_participantsboolean
Example:true

To decide if room participants should be included in the response.

activeboolean

Filter active or inactive room sessions.

room_idstring

Room_id for filtering room sessions.

Consolidated filter parameter (deepObject style). Originally: filter[date_created_at][eq], filter[date_created_at][gte], filter[date_created_at][lte], filter[date_updated_at][eq], filter[date_updated_at][gte], filter[date_updated_at][lte], filter[date_ended_at][eq], filter[date_ended_at][gte], filter[date_ended_at][lte], filter[room_id], filter[active]

{
  "active": true,
  "date_created_at": {
    "eq": "2021-04-25",
    "gte": "2021-04-25",
    "lte": "2021-04-25"
  },
  "date_ended_at": {
    "eq": "2021-04-25",
    "gte": "2021-04-25",
    "lte": "2021-04-25"
  },
  "date_updated_at": {
    "eq": "2021-04-25",
    "gte": "2021-04-25",
    "lte": "2021-04-25"
  },
  "room_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
}
numberinteger

The page number to load.

sizeinteger

The size of the page.

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Response

List room sessions response.

Example response

{
  "data": [
    {
      "active": false,
      "created_at": "2021-04-16T09:46:20.954863Z",
      "ended_at": "2021-04-16T10:24:55.962200Z",
      "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
      "participants": [],
      "record_type": "room_session",
      "room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
      "updated_at": "2021-04-16T10:24:55.962200Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}