List campaigns

GET/v1/accounts/{accountId}/campaigns

Returns the campaigns of the account, optionally filtered and sorted.

Archived campaigns are handled as follows:

When the filter parameter is omitted, all campaigns are returned, including archived ones.
When the filter parameter is sent, even as an empty object ({}), archived campaigns are excluded, unless the filter includes the isArchived field. Use {"isArchived":true} to get only archived campaigns.

Path parameters

accountIduuidRequired

ID of your SIP Caller account. See Account ID.

Query parameters

filterJSON object

Conditions that the records must match, such as {"name":"sales"}. See the Filter fields below, and Filter for the syntax.

sortJSON array

Field and direction used to sort the records, such as ["name","DESC"]. Defaults to ["name","ASC"]. See Sort.

rangeJSON array

Zero-based positions of the first and last records to return, both included, such as [0,99]. Defaults to [0,9]. See Pagination.

Filter fields

Fields that can be used in the filter query parameter. See Filter for the general syntax.

idsarray of uuids

Campaigns with any of the given IDs.

Example: {"ids":["CAMPAIGN_ID_1","CAMPAIGN_ID_2"]}

namestring

Campaigns whose name contains the text (case-insensitive).

Example: {"name":"renewals"}

tagIdsarray of stringsOperators: _ovl_ctn

Campaigns with any of the given tags (_ovl), or with a specific tag (_ctn).

Example: {"tagIds_ovl":["TAG_ID_1","TAG_ID_2"]}

stateenum

Campaigns in the given state. Use an array for several states.

Possible values:DraftActivePausedCanceledFinished

Example: {"state":["Active","Paused"]}

runningPriorityenum

Campaigns with the given running priority.

Possible values:LowNormalHigh

Example: {"runningPriority":"High"}

phoneSystemIduuid

Campaigns that use the given phone system.

Example: {"phoneSystemId":"PHONE_SYSTEM_ID"}

extensionIdstring

Campaigns that use the given extension.

Example: {"extensionId":"EXTENSION_ID"}

dialerobject

Campaigns whose dialer settings contain the given values.

Example: {"dialer":{"mode":"Predictive"}}

startDatedateOperators: _gt_gte_lt_lte

Campaigns by start date.

Example: {"startDate_gte":"2026-10-01"}

endDatedateOperators: _gt_gte_lt_lte

Campaigns by end date.

Example: {"endDate_lt":"2026-12-31"}

numberProvisioningenum

Campaigns with the given number provisioning.

Possible values:StaticDynamic

Example: {"numberProvisioning":"Dynamic"}

numberSelectionenum

Campaigns with the given number selection.

Possible values:FifoLifo

Example: {"numberSelection":"Fifo"}

numberPriorityenum

Campaigns with the given number priority.

Possible values:NotContactedRetryPending

Example: {"numberPriority":"RetryPending"}

callHandlingModeenum

Campaigns with the given call handling mode (the $t field of callHandling).

Possible values:CallflowAiAgent

Example: {"callHandlingMode":"AiAgent"}

callflowIdsarray of uuidsOperators: _ctn_ovl

Campaigns that use the given call flow, either for human answers or voicemails.

Example: {"callflowIds_ctn":"CALLFLOW_ID"}

aiAgentIduuid

Campaigns that use the given AI conversational agent.

Example: {"aiAgentId":"AI_AGENT_ID"}

amdAgentIduuid

Campaigns that use the given AI voicemail detection agent.

Example: {"amdAgentId":"AMD_AGENT_ID"}

webhookEndpointIduuid

Campaigns that send events to the given webhook.

Example: {"webhookEndpointId":"WEBHOOK_ID"}

isArchivedboolean

Archived or non-archived campaigns.

Example: {"isArchived":true}

startedAttimestampOperators: _gt_gte_lt_lte

Campaigns by the date and time they started making calls.

Example: {"startedAt_gte":"2026-10-01T00:00:00"}

endedAttimestampOperators: _gt_gte_lt_lte

Campaigns by the date and time they were canceled or finished.

Example: {"endedAt_lt":"2026-11-01T00:00:00"}

Sort fields

Fields that can be used in the sort query parameter, in ascending (ASC) or descending (DESC) order. See Sort for the general syntax. When sort is omitted, results are sorted by name in ascending order.

namestaterunningPrioritystartDateendDatenumbersCountstartedAtendedAt

Returns

Returns an array of campaign objects for the requested page. The X-Total-Count and Content-Range headers contain the total number of records matching the filter, for example Content-Range: campaigns 0-9/57. See Pagination.

GET

/v1/accounts/ACCOUNT_ID/campaigns

curl -G 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns' \
  -H 'Authorization: Bearer API_KEY_TOKEN' \
  --data-urlencode 'filter={"state":"Active"}' \
  --data-urlencode 'sort=["name","ASC"]' \
  --data-urlencode 'range=[0,99]'

Response

200 OK

[
  {
    "id": "01a0e2b4-5c1d-7f3a-9b2e-6d8c4a1f0e27",
    "name": "Q4 Renewals",
    "tagIds": [],
    "state": "Active",
    "activeStatus": "Running",
    "runningPriority": "Normal",
    "phoneSystemId": "0199817e-52e0-7079-9585-99a655c2acb3",
    "extensionId": "93e5cdfc-6e42-4995-8263-9388a9047c29",
    "dialer": {
      "mode": "Predictive",
      "intensity": 0
    },
    "startDate": "2026-10-01",
    "endDate": null,
    "holidayGroupId": null,
    "timeZoneId": "America/New_York",
    "workingTimes": {
      "monday": [
        {
          "start": "09:00",
          "end": "13:00"
        },
        {
          "start": "14:00",
          "end": "18:00"
        }
      ],
      "tuesday": [
        {
          "start": "09:00",
          "end": "13:00"
        },
        {
          "start": "14:00",
          "end": "18:00"
        }
      ],
      "wednesday": [
        {
          "start": "09:00",
          "end": "13:00"
        },
        {
          "start": "14:00",
          "end": "18:00"
        }
      ],
      "thursday": [
        {
          "start": "09:00",
          "end": "13:00"
        },
        {
          "start": "14:00",
          "end": "18:00"
        }
      ],
      "friday": [
        {
          "start": "09:00",
          "end": "13:00"
        },
        {
          "start": "14:00",
          "end": "18:00"
        }
      ],
      "saturday": [],
      "sunday": []
    },
    "numberProvisioning": "Dynamic",
    "numberSelection": "Fifo",
    "numberPriority": "RetryPending",
    "callPrefix": "",
    "ringTimeout": {
      "value": 30,
      "unit": "Seconds"
    },
    "maxAttempts": 3,
    "retryIntervals": [
      {
        "value": 1,
        "unit": "Hours"
      },
      {
        "value": 1,
        "unit": "Days"
      }
    ],
    "blackListIds": [
      "01a0dedd-b9a2-729d-8e0a-4e3ad9197aea"
    ],
    "callHandling": {
      "$t": "Callflow",
      "answerTypeDetector": {
        "$t": "AmdAgent",
        "amdAgentId": "019f9cef-4a91-7c97-b7cd-edbb06a5038d",
        "unknownAnswerTreatment": "Human",
        "messageForVoicemail": {
          "$t": "OnFirstDetection",
          "callflowId": "019f81ba-a149-731a-a6cb-b47146c5f90d",
          "isCallRetryEnabled": true
        }
      },
      "callflowId": "019f9cd5-e8cd-716b-a9a6-37c9db2f97a2",
      "ttsVoiceId": "azu-en-US-AvaMultilingualNeural"
    },
    "webhookEndpointId": "019af0c3-62d6-70f2-84a1-5ab5671721bb",
    "numbersCount": 1250,
    "progress": {
      "notContacted": 610,
      "contacting": 12,
      "success": 402,
      "failure": 96,
      "retryPending": 118,
      "blacklisted": 12,
      "deleted": 0
    },
    "varNames": [
      "Customer Name",
      "Due Balance"
    ],
    "isArchived": false,
    "interactionLabels": [
      {
        "id": "a6d5b2e5-6b3f-49d8-aaa3-bc7b4c693f05",
        "label": "Renewal confirmation"
      }
    ],
    "createdAt": "2026-09-28T14:02:11.482",
    "updatedAt": "2026-10-01T09:00:02.731",
    "deletedAt": null,
    "startedAt": "2026-10-01T09:00:04.118",
    "endedAt": null
  }
]

The campaign object

Retrieve a campaign

Trustpilot

List campaigns

Path parameters

Query parameters

Filter fields

Sort fields

Returns

Product

Solutions

Company

Help & Docs

Legal