Skip to main content
POST
/
batch-call
/
list
curl -X POST "https://api.zudu.ai/batch-call/list" \
  -H "X-API-KEY: sk_Abc123Def456..." \
  -H "X-API-SECRET: s3cr3t_Xyz789..." \
  -d '{
    "filter_criteria": {
      "status": ["completed", "failed"],
      "agent_id": ["agent_123", "agent_456"],
      "name": ["campaign"]
    },
    "pagination": {
      "page": 0,
      "limit": 20
    },
    "sort_by": "created_at",
    "sort_order": "descending"
  }'

{
  "message": "Batch calls retrieved successfully with filters",
  "status": "success",
  "data": {
    "batch_calls": [
      {
        "batch_call_id": "batch_abc123",
        "name": "Customer Campaign",
        "status": "COMPLETED",
        "agent_id": "agent_123",
        "total_task_count": 100
      }
    ],
    "pagination": {
      "page": 0,
      "limit": 20,
      "total_count": 15,
      "total_pages": 1
    },
    "applied_filters": {
      "status": "2 values",
      "agent_id": "2 values",
      "name": "1 values"
    }
}
Retrieve batch calls with advanced filtering capabilities. Supports filtering by status, agent ID, name search, and more. 
curl -X POST "https://api.zudu.ai/batch-call/list" \
  -H "X-API-KEY: sk_Abc123Def456..." \
  -H "X-API-SECRET: s3cr3t_Xyz789..." \
  -d '{
    "filter_criteria": {
      "status": ["completed", "failed"],
      "agent_id": ["agent_123", "agent_456"],
      "name": ["campaign"]
    },
    "pagination": {
      "page": 0,
      "limit": 20
    },
    "sort_by": "created_at",
    "sort_order": "descending"
  }'

{
  "message": "Batch calls retrieved successfully with filters",
  "status": "success",
  "data": {
    "batch_calls": [
      {
        "batch_call_id": "batch_abc123",
        "name": "Customer Campaign",
        "status": "COMPLETED",
        "agent_id": "agent_123",
        "total_task_count": 100
      }
    ],
    "pagination": {
      "page": 0,
      "limit": 20,
      "total_count": 15,
      "total_pages": 1
    },
    "applied_filters": {
      "status": "2 values",
      "agent_id": "2 values",
      "name": "1 values"
    }
}

​
Headers

​
X-API-KEY
string
required
Your API key (format: sk_...)
​
X-API-SECRET
string
required
Your API secret (format: s3cr3t_...)

​
Request Body

​
filter_criteria
object
Filter criteria object:
  • status (array of strings): Filter by status values (draft, scheduled, sent, completed, failed)
  • agent_id (array of strings): Filter by agent IDs (format: agent_...)
  • name (array of strings): Search batch call names (case-insensitive contains)
​
pagination
object
Pagination parameters:
  • page (number): Page number (0-based, default: 0)
  • limit (number): Results per page (default: 20, max: 100)
Note: If limit is not provided, ALL matching batch calls are returned.
​
sort_by
string
Field to sort by (default: updated_at)Options: created_at, updated_at, scheduled_timestamp, name, status, total_task_count
​
sort_order
string
Sort direction (default: descending)Options: ascending, descending

​
Response Fields

​
applied_filters
object
Summary of filters that were applied to the query
​
batch_calls
array
Array of batch call objects matching the filter criteria
​
pagination
object
Pagination metadata

​
Notes

  • Multiple filter values are combined with OR logic (e.g., status=[“completed”, “failed”] returns calls with either status)
  • Name search is case-insensitive and uses “contains” matching
  • All filters are combined with AND logic
  • When limit is not provided, all matching results are returned