v1

latestOpenAPI 3.0.1MIT2026-07-26104203277.0 KB

List campaigns with pagination

Retrieves a paginated list of campaigns with optional filtering by voice agent and search query.

get/v1/voice-agents/campaigns

Query parameters

voiceAgentIdstring uuid

Example:68f7656f-098b-4c43-b165-7cfd2cc8ac40

Optional voice agent ID to filter campaigns.

takeinteger

Example:10

Number of items to return per page.

skipinteger

Number of items to skip (offset).

searchstring

Example:Q1 Customer

Search query for campaign name or campaign ID.

Response

Successful response

successboolean

messagestring

messageKeystring

Example response

{
  "success": true,
  "message": "Campaigns retrieved successfully",
  "messageKey": "CAMPAIGNS_RETRIEVED_SUCCESSFULLY",
  "data": {
    "campaigns": [
      {
        "id": "a8f7656f-098b-4c43-b165-7cfd2cc8ac50",
        "name": "Q1 Customer Outreach",
        "status": "SCHEDULED",
        "sendType": "NOW",
        "scheduledDate": "2025-12-01T09:00:00Z",
        "scheduledTimezone": "America/New_York",
        "timeRange": {
          "days": [
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY"
          ],
          "startCallingTime": "09:00",
          "endCallingTime": "17:00"
        },
        "reservedConcurrency": 10,
        "projectId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
        "voiceAgentId": "68f7656f-098b-4c43-b165-7cfd2cc8ac40",
        "recipientsCount": 100,
        "createdAt": "2025-12-06T10:00:00.000Z",
        "updatedAt": "2025-12-06T10:00:00.000Z"
      }
    ],
    "totalCount": 50,
    "returnedCount": 10
  }
}