List a Room Session's Members

GET 
/room_sessions/:id/members

A list of Members for a particular Room Session.

Permissions

The API token must include the following scopes: Video.

Request

Path Parameters

id uuidrequired

Unique ID of the Room Session

Responses

200

OK

application/json

Schema

Schema

links

object

self string

first string

next string

prev string

data

object[]

Array [

id uuid

Unique ID of the Member

name uuid

Display name of the Member

room_session_id uuid

Unique ID of the Room Session.

join_time date-time

Timestamp of when the Member joined the Room Session

leave_time date-time

Timestamp of when the Member left the Room Session

duration integer

How long the Member stayed in the Room Session, in seconds.

]

Example (from schema)

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "room_session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "join_time": "2024-07-29T15:51:28.071Z",
      "leave_time": "2024-07-29T15:51:28.071Z",
      "duration": 120
    }
  ]
}

Loading...