List All Conferences

GET

api

Account

{auth_id}

Conference

List conferences

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "conferences": [],
  "api_id": "API_REQUEST_ID"
}

GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/

This endpoint returns the conference names currently reported for your account. Use the result as supplementary status information and maintain your own room registry for authoritative discovery and lifecycle tracking.

Known limitation: This endpoint can return 200 OK with an empty conferences array while conferences are active. Do not use it as the source of truth for monitoring, billing, cleanup, or destructive operations.

Authentication required:

X-Auth-ID - Your account Auth ID
X-Auth-Token - Your account Auth Token
Content-Type: application/json

Use cases: Supplement an operational dashboard, inspect room names returned by the API, or troubleshoot a conference already tracked by your application.

Path parameters

Field	Type	Required	Description
`auth_id`	string	Yes	Your Vobiz account ID (e.g., `{auth_id}`)

No request body or query parameters needed. Simply use the GET method on the base conference endpoint.

Response

The documented response contains conference names and an API request identifier.

Response - 200 OK (Multiple Conferences)

{
  "conferences": [
    "Team Meeting",
    "Sales Call",
    "Customer Support Conference"
  ],
  "api_id": "API_REQUEST_ID"
}

Response - 200 OK (Empty Result)

{
  "conferences": [],
  "api_id": "API_REQUEST_ID"
}

Response Fields

conferences - Array of conference names reported by the API. An empty array is inconclusive and does not prove that no conferences are running.
api_id - Unique identifier for this API request

The response only includes conference names, not detailed information. The Retrieve a Conference endpoint is also subject to a known response limitation.

Example Request

List All Active Conferences

cURL Request

curl -X GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Get details for a reported conference

For each name returned by the API, you can request conference details. Do not use this flow as the only way to discover rooms; begin with the room registry maintained by your application.

# Get list of conference names
curl -X GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

# Response: {"conferences": ["Team Meeting", "Sales Call"]}

# Get details for "Team Meeting"
curl -X GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/Team%20Meeting/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

# Response includes member count, runtime, and all participants

Do not use this endpoint alone for billing, cleanup, destructive operations, or authoritative room discovery. An empty result can occur while conferences are active.

Best Practices:

Do not use this endpoint as the only source for dashboard or conference-state updates
Cache results to reduce API calls - refresh only when needed
Treat an empty conference array as inconclusive because active rooms may be omitted
Iterate through results to get detailed info only when needed
Implement rate limiting to avoid excessive API calls
Use WebSockets or webhooks for real-time updates instead of frequent polling

Example: Dashboard Implementation

JavaScript Dashboard Logic

// Fetch all active conferences
async function getActiveConferences() {
  const response = await fetch(
    'https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/',
    {
      headers: {
        'X-Auth-ID': '{auth_id}',
        'X-Auth-Token': 'YOUR_AUTH_TOKEN'
      }
    }
  );

  const data = await response.json();
  if (data.conferences.length === 0) {
    console.warn('The API returned no room names; confirm against application state');
  }
  return data.conferences; // Array of conference names
}

// Get details for each conference
async function getConferenceDetails(conferenceName) {
  const encodedName = encodeURIComponent(conferenceName);
  const response = await fetch(
    `https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/${encodedName}/`,
    {
      headers: {
        'X-Auth-ID': '{auth_id}',
        'X-Auth-Token': 'YOUR_AUTH_TOKEN'
      }
    }
  );

  const data = await response.json();
  return data.error ? null : data;
}

// Supplement your application-tracked state with API-reported room names
setInterval(async () => {
  const conferences = await getActiveConferences();
  console.log(`Conference names returned by API: ${conferences.length}`);

  // Get details for each
  for (const name of conferences) {
    const details = await getConferenceDetails(name);
    if (details) {
      console.log(`${name}: ${details.conference_member_count} members`);
    } else {
      console.warn(`Details are currently unavailable for ${name}`);
    }
  }
}, 15000);

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

auth_id

string

required

Your account Auth ID

Example:

"MA_XXXXXX"

Response

200 - application/json

List of conferences

api_id

string

required

conferences

string[]

required

Conference names reported by the API. An empty array is inconclusive.

⌘I

List conferences

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "conferences": [],
  "api_id": "API_REQUEST_ID"
}

​Path parameters

​Response

​Response Fields

​Example Request

​List All Active Conferences

​Get details for a reported conference

​Example: Dashboard Implementation

Authorizations

Path Parameters

Response

Path parameters

Response

Response Fields

Example Request

List All Active Conferences

Get details for a reported conference

Example: Dashboard Implementation