Skip to main content
GET
/
api
/
v1
/
calls
List calls
curl --request GET \
  --url https://voxworks.ai/api/v1/calls \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "calls": [
    {
      "id": "<string>",
      "team_id": "<string>",
      "contact_id": "<string>",
      "script_id": "<string>",
      "type": "<string>",
      "status": "<string>",
      "progress": "<string>",
      "scheduled_time": "2023-11-07T05:31:56Z",
      "actual_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "duration": 123,
      "end_reason": "<string>",
      "call_summary": "<string>",
      "structured_data": {},
      "transcript": "<string>",
      "recording_url": "<string>",
      "objectives": [
        {}
      ]
    }
  ],
  "meta": {
    "limit": 123,
    "total": 123,
    "next_cursor": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.voxworks.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key from Voxworks, sent as Authorization: Bearer YOUR_API_KEY.

Query Parameters

status
string
type
enum<string>
Available options:
outbound,
inbound,
web
progress
string
contact_id
string
script_id
string
created_after
string<date-time>
created_before
string<date-time>
cursor
string<date-time>

Use meta.next_cursor from the previous response.

limit
integer
default:100
Required range: 1 <= x <= 500

Response

Calls returned.

success
boolean
required
Example:

true

calls
object[]
required
meta
object
required