> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List All Conferences

> Retrieve all active conference rooms on the account.

```http theme={null}
GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/
```

This endpoint retrieves a list of all ongoing conferences for your account and returns their names. You can then use these names to retrieve detailed information about specific conferences or perform operations on them.

<Info>
  **Authentication required:**

  * `X-Auth-ID` - Your account Auth ID
  * `X-Auth-Token` - Your account Auth Token
  * `Content-Type: application/json`
</Info>

<Tip>
  **Use Cases:** Dashboard displays showing active conferences, monitoring conference activity, generating conference reports, administrative oversight, system health checks.
</Tip>

## Path parameters

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

<Tip>
  **No request body or query parameters needed.** Simply use the GET method on the base conference endpoint.
</Tip>

## Response

Returns the names of all ongoing conferences associated with the account.

```json Response - 200 OK (Multiple Conferences) theme={null}
{
  "conferences": [
    "Team Meeting",
    "Sales Call",
    "Customer Support Conference"
  ],
  "api_id": "816e903e-58c4-11e1-86da-adf28403fe48"
}
```

```json Response - 200 OK (No Active Conferences) theme={null}
{
  "conferences": [],
  "api_id": "816e903e-58c4-11e1-86da-adf28403fe48"
}
```

### Response Fields

* `conferences` - Array of conference names currently active. Empty array if no conferences are running.
* `api_id` - Unique identifier for this API request

<Info>
  **Note:** The response only includes conference names, not detailed information. To get member counts, runtime, and participant details, use the [Retrieve a Conference](/conference/retrieve-conference) endpoint for each conference name.
</Info>

## Example Request

### List All Active Conferences

```bash cURL Request theme={null}
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"
```

### Typical Workflow: Get Conference Details

Use this endpoint to discover conference names, then retrieve detailed information for each:

<CodeGroup>
  ```bash Step 1: List all conferences theme={null}
  # 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"]}
  ```

  ```bash Step 2: Get details for specific conference theme={null}
  # 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
  ```
</CodeGroup>

<Warning>
  **Common Use Cases:**

  * **Dashboard overview:** Display all active conferences in admin panel
  * **System monitoring:** Track number of concurrent conferences
  * **Resource management:** Identify conferences to free up capacity
  * **Reporting:** Generate usage statistics and activity reports
  * **Cleanup operations:** Find abandoned or long-running conferences
  * **Billing:** Track active conference usage for billing purposes
</Warning>

<Tip>
  **Best Practices:**

  * Poll this endpoint periodically for dashboard updates (recommended: every 10-30 seconds)
  * Cache results to reduce API calls - refresh only when needed
  * Handle empty conference arrays gracefully (no active conferences is normal)
  * 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
</Tip>

### Example: Dashboard Implementation

```javascript JavaScript Dashboard Logic theme={null}
// 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();
  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'
      }
    }
  );

  return await response.json();
}

// Update dashboard every 15 seconds
setInterval(async () => {
  const conferences = await getActiveConferences();
  console.log(`Active conferences: ${conferences.length}`);

  // Get details for each
  for (const name of conferences) {
    const details = await getConferenceDetails(name);
    console.log(`${name}: ${details.conference_member_count} members`);
  }
}, 15000);
```


## OpenAPI

````yaml GET /api/v1/Account/{auth_id}/Conference/
openapi: 3.0.3
info:
  title: Vobiz API
  description: >
    The Vobiz API lets you make calls, manage phone numbers, configure SIP
    trunks, 

    and access account data programmatically.


    **Base URL:** `https://api.vobiz.ai`


    **Authentication:** All requests require `X-Auth-ID` and `X-Auth-Token`
    headers.

    Obtain these from your [Vobiz Console](https://console.vobiz.ai).
  version: '1.0'
  contact:
    email: support@vobiz.ai
    url: https://vobiz.ai
servers:
  - url: https://api.vobiz.ai
    description: Production
security:
  - AuthID: []
    AuthToken: []
tags:
  - name: Account
    description: Manage your account details and credentials
  - name: Balance
    description: Retrieve balance and transaction history
  - name: Calls
    description: Make and manage outbound calls
  - name: Live Calls
    description: Retrieve and control in-progress calls
  - name: CDR
    description: Call detail records and history
  - name: Sub-Accounts
    description: Create and manage sub-accounts
  - name: Phone Numbers
    description: Manage phone numbers on your account
  - name: Trunks
    description: Configure SIP trunks for inbound and outbound calling
  - name: Conference
    description: Manage conference calls and members
  - name: Applications
    description: Manage voice and messaging applications with webhook URLs
  - name: Endpoints
    description: Manage SIP endpoints for IP phones, softphones, and SIP clients
  - name: Partner API
    description: >-
      Reseller and white-label endpoints for managing customer sub-accounts,
      balance transfers, transactions, CDRs, and DIDs across your partner
      ecosystem
  - name: Sub-Account KYC
    description: >-
      Per-sub-account KYC verification (PAN, GST, CIN, Aadhaar, DigiLocker) and
      hosted email/redirect KYC sessions. Authenticated as the parent main
      account.
  - name: Sub-Account KYC (Test Mode)
    description: >-
      Mock KYC endpoints that never call the upstream provider. Drive verified /
      failed / pending / error outcomes with magic inputs for integration
      testing.
paths:
  /api/v1/Account/{auth_id}/Conference/:
    get:
      tags:
        - Conferences
      summary: List conferences
      description: Retrieve all active conference rooms on the account.
      operationId: list-conferences
      parameters:
        - $ref: '#/components/parameters/AuthId'
      responses:
        '200':
          description: List of conferences
          content:
            application/json:
              example:
                objects:
                  - conference_name: My Conf Room
                    member_count: 3
              schema:
                type: object
                properties:
                  api_id:
                    type: string
                  conferences:
                    type: array
                required:
                  - api_id
                  - conferences
components:
  parameters:
    AuthId:
      name: auth_id
      in: path
      required: true
      description: Your account Auth ID
      schema:
        type: string
        example: MA_XXXXXX
  securitySchemes:
    AuthID:
      type: apiKey
      in: header
      name: X-Auth-ID
      description: Your Vobiz account Auth ID
    AuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Your Vobiz account Auth Token

````