Skip to main content
GET
/
api
/
v1
/
presence
/
rooms
/
{roomId}
/
users
Get active viewers in a room
curl --request GET \
  --url https://apix.us.amity.co/api/v1/presence/rooms/{roomId}/users \
  --header 'Authorization: Bearer <token>'
{
  "viewers": [
    {
      "userId": "<string>",
      "joinedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "limit": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

roomId
string
required

The ID of the room

Query Parameters

orderBy
enum<string>
Available options:
asc,
desc
limit
integer
default:200

Maximum number of viewers to return

Required range: 1 <= x <= 200

Response

Get room viewers response

List of room viewers

viewers
object[]
required
total
integer
required

Number of viewers returned in this response

limit
integer
required

Maximum number of viewers requested