Room Participants API

Rooms Participants operations API

View a list of room participants.

SecuritybearerAuth
Request
query Parameters
filter[date_joined_at][eq]
string <date>

ISO 8601 date for filtering room participants that joined on that date.

Example: filter[date_joined_at][eq]=2021-04-25
filter[date_joined_at][gte]
string <date>

ISO 8601 date for filtering room participants that joined after that date.

Example: filter[date_joined_at][gte]=2021-04-25
filter[date_joined_at][lte]
string <date>

ISO 8601 date for filtering room participants that joined before that date.

Example: filter[date_joined_at][lte]=2021-04-25
filter[date_updated_at][eq]
string <date>

ISO 8601 date for filtering room participants updated on that date.

Example: filter[date_updated_at][eq]=2021-04-25
filter[date_updated_at][gte]
string <date>

ISO 8601 date for filtering room participants updated after that date.

Example: filter[date_updated_at][gte]=2021-04-25
filter[date_updated_at][lte]
string <date>

ISO 8601 date for filtering room participants updated before that date.

Example: filter[date_updated_at][lte]=2021-04-25
filter[date_left_at][eq]
string <date>

ISO 8601 date for filtering room participants that left on that date.

Example: filter[date_left_at][eq]=2021-04-25
filter[date_left_at][gte]
string <date>

ISO 8601 date for filtering room participants that left after that date.

Example: filter[date_left_at][gte]=2021-04-25
filter[date_left_at][lte]
string <date>

ISO 8601 date for filtering room participants that left before that date.

Example: filter[date_left_at][lte]=2021-04-25
filter[context]
string

Filter room participants based on the context.

Example: filter[context]=Alice
filter[session_id]
string

Session_id for filtering room participants.

Example: filter[session_id]=0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

page[number]
integer >= 1
Default: 1

The page number to load

Responses
200

List room participants response.

Response Schema: application/json
Array of objects (RoomParticipant)
object (PaginationMeta)
get/room_participants
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "context": "Alice",
      • "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
      • "joined_at": "2021-04-16T09:46:20.954863Z",
      • "left_at": "2021-04-16T10:24:55.962200Z",
      • "record_type": "room_participant",
      • "session_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
    }
}
View a room participant.
SecuritybearerAuth 
Request 
path Parameters
room_participant_id
required
string <uuid> 
The unique identifier of a room participant.


 
 Example:  0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
Responses 
200
Get room participant response.


Response Schema: application/json
object (RoomParticipant) 
 
context
string
Context provided to the given participant through the client SDK


 
id
string <uuid> 
A unique identifier for the room participant.


 
joined_at
string <datetime> 
ISO 8601 timestamp when the participant joined the session.


 
left_at
string <datetime> 
ISO 8601 timestamp when the participant left the session.


 
record_type
string
 
session_id
string <uuid> 
Identify the room session that participant is part of.


 
updated_at
string <datetime> 
ISO 8601 timestamp when the participant was updated.


 
404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/room_participants/{room_participant_id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "context": "Alice",
    • "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
    • "joined_at": "2021-04-16T09:46:20.954863Z",
    • "left_at": "2021-04-16T10:24:55.962200Z",
    • "record_type": "room_participant",
    • "session_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
    • "updated_at": "2021-04-16T10:24:55.962200Z"
    }
}