Get List of Video Conferences

Prev Next
Get
/api/v1/video-conference.list

Use this endpoint to get the list of video calls for a specific room. Rate limiting: 3 requests per 1000ms.

Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Query parameters
roomId
stringRequired

Enter the room ID for which you want to view the list of video conferences. Make sure that you have access to the room.

Example674eca3e43725ce31dd9a2e8
offset
integer

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.

Example50
count
integer

How many items to return. Refer to the official documentation to learn more.

Example50
Responses
200

OK

Example 1
{
  "data": [
    {
      "_id": "69786d0ac8b05330207814bd",
      "type": "videoconference",
      "users": [
        {
          "_id": "fRv4qm8ycWHXSA7af",
          "username": "jane.doe",
          "name": "jane",
          "avatarETag": null,
          "ts": "2026-01-27T07:45:14.977Z"
        }
      ],
      "messages": {
        "started": "8AqsmsMXDePKfDbHv"
      },
      "status": 1,
      "anonymousUsers": 0,
      "createdAt": "2026-01-27T07:45:14.533Z",
      "providerName": "googlemeet",
      "ringing": true,
      "title": "ui-test",
      "rid": "674eca3e43725ce31dd9a2e8",
      "createdBy": {
        "_id": "fRv4qm8ycWHXSA7af",
        "name": "jane",
        "username": "jane.doe"
      },
      "_updatedAt": "2026-01-27T07:45:14.977Z",
      "url": "http://g.co/meet/RocketChat_69786d0ac8b05330207814bd"
    },
    {
      "_id": "6772586c8dd061cca4edc998",
      "type": "videoconference",
      "users": [
        {
          "_id": "fRv4qm8ycWHXSA7af",
          "username": "jane.doe",
          "name": "jane",
          "ts": "2024-12-30T08:23:11.130Z"
        }
      ],
      "messages": {
        "started": "sTDmP2WSH6Rwt89iw"
      },
      "status": 2,
      "anonymousUsers": 0,
      "createdAt": "2024-12-30T08:23:08.655Z",
      "providerName": "jitsi",
      "rid": "674eca3e43725ce31dd9a2e8",
      "title": "ui-test",
      "createdBy": {
        "_id": "fRv4qm8ycWHXSA7af",
        "name": "jane",
        "username": "jane.doe"
      },
      "_updatedAt": "2024-12-31T09:00:00.025Z",
      "url": "https://meet.jit.si/RocketChat6772586c8dd061cca4edc998",
      "endedAt": "2024-12-31T09:00:00.025Z"
    }
  ],
  "offset": 0,
  "count": 2,
  "total": 2,
  "success": true
}
Expand All
object
data
Array of object
object
_id
string
type
string
users
Array of object
object
_id
string
username
string
name
string
avatarETag
string
ts
string
messages
object
started
string
status
integer
anonymousUsers
integer
createdAt
string
providerName
string
ringing
boolean
title
string
rid
string
createdBy
object
_id
string
name
string
username
string
_updatedAt
string
url
string
endedAt
string
offset
integer
count
integer
total
integer
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'roomId' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string