List campaigns

GET/v1/campaigns

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Query Parameters

limit?integer

Default50

Range1 <= value <= 200

offset?integer

Default0

Range0 <= value <= 9007199254740991

status?string

Value in"draft" | "active" | "paused" | "completed" | "cancelled"

channel?string

Value in"voice" | "sms" | "rvm" | "sequence"

Response Body

`application/json`

cURL

curl -X GET "https://example.com/campaigns"

{
  "success": true,
  "campaigns": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "status": "draft",
      "statusReason": "string",
      "channel": "voice",
      "campaignType": "single_channel",
      "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
      "provider": "stride",
      "agentId": "bc309ecf-5f66-4057-93c5-6611cc9cb7b2",
      "agentDistribution": [
        {
          "agentId": "bc309ecf-5f66-4057-93c5-6611cc9cb7b2",
          "weight": 0
        }
      ],
      "stickyAgent": true,
      "phoneNumberId": "8e9ce3fb-4d22-4fe3-baa7-b7892dd942d7",
      "conversationAgentId": "e79cde5d-69b1-4cf1-bafa-f21f84f14a80",
      "smsConfig": {
        "property1": null,
        "property2": null
      },
      "voicemailConfig": {
        "enabled": true,
        "mode": "tts",
        "message": "string",
        "audioUrl": "string"
      },
      "emailServiceId": "9dd4ebbd-a81f-4757-b4eb-1058b80bb183",
      "externalAgentId": "string",
      "externalAgentName": "string",
      "externalPhoneNumberId": "string",
      "externalPhoneNumber": "string",
      "sourceType": "string",
      "sequence": null,
      "dispositionMap": {
        "property1": "string",
        "property2": "string"
      },
      "dispositionDescriptions": {
        "property1": "string",
        "property2": "string"
      },
      "maxAttempts": -9007199254740991,
      "maxConcurrentCalls": -9007199254740991,
      "callingHoursStart": "string",
      "callingHoursEnd": "string",
      "callingDays": [
        "string"
      ],
      "timezone": "string",
      "useContactTimezone": true,
      "callbackDoubleDial": true,
      "allowReentry": true,
      "stopOnReply": true,
      "stopOnReplyChannels": [
        "string"
      ],
      "totalContacts": -9007199254740991,
      "contactsCompleted": -9007199254740991,
      "contactsRemaining": -9007199254740991,
      "contactsInProgress": -9007199254740991,
      "startedAt": "2019-08-24T14:15:22Z",
      "completedAt": "2019-08-24T14:15:22Z",
      "scheduledStartAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "limit": -9007199254740991,
    "offset": -9007199254740991,
    "total": -9007199254740991,
    "hasMore": true
  }
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "unauthorized"
}

{
  "success": false,
  "error": "API key lacks write permission"
}

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`