v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Campaign

Get a list of campaigns

Retrieves a paginated list of campaigns.

get/campaigns

Query parameters

page_sizeinteger

Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

Response

A list of campaigns.

next_page_tokenstring

Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.

Example response

{
  "result": [
    {
      "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "type": "call",
      "name": "Q1 Outbound Campaign",
      "detail": "Quarterly customer outreach campaign",
      "status": "run",
      "service_level": 80,
      "end_handle": "stop",
      "actions": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "next_id": "550e8400-e29b-41d4-a716-446655440000",
          "type": "talk",
          "tm_execute": "2026-01-15T09:30:00.000000Z"
        }
      ],
      "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
      "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
      "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
      "next_campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}