View a room participant.

GET 
/room_participants/:room_participant_id

View a room participant.

Request

Path Parameters

room_participant_id uuidrequired

The unique identifier of a room participant.

Responses

200: Get room participant response.

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

A unique identifier for the room participant.

session_id uuid

Identify the room session that participant is part of.

context string

Context provided to the given participant through the client SDK

joined_at datetime

ISO 8601 timestamp when the participant joined the session.

updated_at datetime

ISO 8601 timestamp when the participant was updated.

left_at datetime

ISO 8601 timestamp when the participant left the session.

record_type string

{
  "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"
  }
}

404: Resource not found

application/json

• Schema
• Example (from schema)

Schema

code intrequired
title stringrequired
detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "source": {
    "pointer": "string",
    "parameter": "string"
  },
  "meta": {}
}

Loading...