View a list of room participants.
GET/room_sessions/:room_session_id/participants
Request
Path Parameters
The unique identifier of a room session.
Query Parameters
ISO 8601 date for filtering room participants that joined on that date.
ISO 8601 date for filtering room participants that joined after that date.
ISO 8601 date for filtering room participants that joined before that date.
ISO 8601 date for filtering room participants updated on that date.
ISO 8601 date for filtering room participants updated after that date.
ISO 8601 date for filtering room participants updated before that date.
ISO 8601 date for filtering room participants that left on that date.
ISO 8601 date for filtering room participants that left after that date.
ISO 8601 date for filtering room participants that left before that date.
Filter room participants based on the context.
Possible values: >= 1
and <= 250
Default value: 20
The size of the page.
Possible values: >= 1
Default value: 1
The page number to load.
Responses
200: List room participants response.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
A unique identifier for the room participant.
Identify the room session that participant is part of.
Context provided to the given participant through the client SDK
ISO 8601 timestamp when the participant joined the session.
ISO 8601 timestamp when the participant was updated.
ISO 8601 timestamp when the participant left the session.
meta
object
{
"data": [
{
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"session_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
"context": "Alice",
"joined_at": "2021-04-16T09:46:20.954863Z",
"updated_at": "2021-04-16T10:24:55.962200Z",
"left_at": "2021-04-16T10:24:55.962200Z",
"record_type": "room_participant"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}