Get
/api/v1/video-conference.joinable
Lists the video conferences running now that you can join, including calls you are already in and calls that are ringing for you. Empty calls are not listed. Requests are limited to 30 per minute per client IP address.
Changelog
| Version | Description |
|---|---|
| 8.9.0 | Added |
Header parameters
X-User-Id
stringRequired
The user ID.
ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired
The authentication token.
Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Responses
200
OK
Success Example
{
"calls": [
{
"callId": "697887e3c8b0533020781a4a",
"name": "Sprint planning",
"createdAt": "2026-09-23T10:00:00.000Z",
"usersCount": 2,
"participants": [
{
"_id": "rbAXPnMktTFbNpwtJ",
"username": "dana.reyes",
"name": "Dana Reyes"
},
{
"_id": "kP3wQz8LmNvT5rXyB",
"username": "sam.okafor",
"name": "Sam Okafor"
}
],
"joined": false,
"declined": false,
"ringingAt": "2026-09-23T10:00:02.000Z"
}
],
"success": true
}object
calls
Array of object
object
callId
string
name
string
The conference title, or the room name if the conference has no title.
createdAt
string
usersCount
integer
The number of people in the call now.
participants
Array of object
Some of the people in the call. The list is capped by the server; use usersCount for the total.
object
_id
string
username
string
name
string
joined
boolean
Whether you are in the call.
declined
boolean
Whether you declined the call.
ringingAt
string
When you were last rung for this call.
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string