Skip to main content
GET
/
batch-call
/
list
List batch calls
curl --request GET \
  --url http://localhost:8080/batch-call/list \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>'
{
  "message": "Batch calls retrieved successfully with real-time metrics",
  "status": "success",
  "error": null,
  "data": {
    "organization_id": "e3yn0c4mivqs8y4yhb5k",
    "batch_calls": [
      {
        "batch_call_id": "batch_call_a1b2c3d4e5f6789012345678901234567",
        "name": "Q1 Sales Campaign",
        "from_number": "+14157774444",
        "status": "completed",
        "total_task_count": 100,
        "sent": 100,
        "picked_up": 75,
        "completed": 68,
        "scheduled_timestamp": 1735718400,
        "agent_id": "agent_uuid-here",
        "organization_id": "e3yn0c4mivqs8y4yhb5k"
      }
    ],
    "pagination": {
      "page": 0,
      "limit": 20,
      "total_count": 45,
      "total_pages": 3,
      "has_next_page": true,
      "has_previous_page": false
    },
    "returned_count": 20,
    "sort_order": "descending",
    "sort_by": "updated_at"
  }
}

Authorizations

​
X-API-KEY
string
header
required

API Key for MCP server and external service authentication

​
X-API-SECRET
string
header
required

API Secret for MCP server and external service authentication

Query Parameters

​
page
integer<int32>
default:0

Page number (0-based, default: 0)

Required range: x >= 0
Example:

0

​
limit
integer<int32>
default:20

Items per page (default: 20, max: 100). Omit/null for ALL data

Required range: 1 <= x <= 100
Example:

20

​
sort_by
string
default:updated_at

Sort field: created_at, updated_at, scheduled_timestamp, name, status, total_task_count

Example:

"updated_at"

​
sort_order
string
default:descending

Sort direction: ascending, descending

Example:

"descending"

​
size
integer<int32>

Alternate page size parameter

​
performance_mode
string

Performance mode: fast, accurate, ultra_fast

Response

Batch calls retrieved successfully with real-time metrics

​
message
string
​
status
string
​
error
string | null
​
data
object