List Conferences | Pinnacle

{
  "data": [
    {
      "id": "conf_Hk2mX9pQ4rT7vB1nL8sW",
      "label": "escalation-4412",
      "status": "waiting",
      "participant_count": 1,
      "max_participants": 1,
      "hold_audio_url": "string",
      "speaking_events": true,
      "metadata": {},
      "created_at": "2024-01-15T09:30:00Z",
      "started_at": "2024-01-15T09:30:00Z",
      "ended_at": "2024-01-15T09:30:00Z",
      "ended_reason": "empty",
      "participants": [
        {
          "call_id": "call_7cQe4F8xT1yB2mN9pK3L",
          "conference_id": "conf_Hk2mX9pQ4rT7vB1nL8sW",
          "label": "supervisor",
          "status": "dialing",
          "from": "+14155559876",
          "to": "+14155551234",
          "muted": true,
          "on_hold": true,
          "whisper_to": [
            "string"
          ],
          "end_conference_on_leave": true,
          "joined_at": "2024-01-15T09:30:00Z",
          "left_at": "2024-01-15T09:30:00Z",
          "left_reason": "hangup"
        }
      ]
    }
  ]
}

Your team's conferences, newest first, each with its participants.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Query parameters

limitintegerOptional1-100Defaults to 25

statusenumOptional

waiting: Created, but nobody has joined yet.
active: At least one participant has joined.
ended: Over. Every participant’s call has been hung up.

Allowed values:

Response

Conferences.

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error