List campaigns

GET

/v1/campaigns

curl --request GET \
  --url 'https://api.vocapable.com/v1/campaigns?limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

• HTTPBearer

Parameters

Query Parameters

limit

Limit

integer

default: 50 >= 1 <= 200

cursor

Any of:

string

string

null

null

agent_definition_id

Any of:

string

string

null

null

Filter on agent_definition_id. Comma-separated values are OR.

agent_definition_id.gte

Any of:

string

string

null

null

Filter on agent_definition_id with the gte operator.

agent_definition_id.lte

Any of:

string

string

null

null

Filter on agent_definition_id with the lte operator.

agent_definition_id.gt

Any of:

string

string

null

null

Filter on agent_definition_id with the gt operator.

agent_definition_id.lt

Any of:

string

string

null

null

Filter on agent_definition_id with the lt operator.

agent_definition_id.in

Any of:

string

string

null

null

Filter on agent_definition_id with the in operator.

contact_list_id

Any of:

string

string

null

null

Filter on contact_list_id. Comma-separated values are OR.

contact_list_id.gte

Any of:

string

string

null

null

Filter on contact_list_id with the gte operator.

contact_list_id.lte

Any of:

string

string

null

null

Filter on contact_list_id with the lte operator.

contact_list_id.gt

Any of:

string

string

null

null

Filter on contact_list_id with the gt operator.

contact_list_id.lt

Any of:

string

string

null

null

Filter on contact_list_id with the lt operator.

contact_list_id.in

Any of:

string

string

null

null

Filter on contact_list_id with the in operator.

created_at

Any of:

string

string

null

null

Filter on created_at. Comma-separated values are OR.

created_at.gte

Any of:

string

string

null

null

Filter on created_at with the gte operator.

created_at.lte

Any of:

string

string

null

null

Filter on created_at with the lte operator.

created_at.gt

Any of:

string

string

null

null

Filter on created_at with the gt operator.

created_at.lt

Any of:

string

string

null

null

Filter on created_at with the lt operator.

created_at.in

Any of:

string

string

null

null

Filter on created_at with the in operator.

status

Any of:

string

string

null

null

Filter on status. Comma-separated values are OR.

status.gte

Any of:

string

string

null

null

Filter on status with the gte operator.

status.lte

Any of:

string

string

null

null

Filter on status with the lte operator.

status.gt

Any of:

string

string

null

null

Filter on status with the gt operator.

status.lt

Any of:

string

string

null

null

Filter on status with the lt operator.

status.in

Any of:

string

string

null

null

Filter on status with the in operator.

Responses

200

Successful Response

Media typeapplication/json

CursorPage[CampaignSummary]

object

data

required

Data

Array<object>

CampaignSummary

A campaign as a list endpoint returns it, counters included.

object

id

required

Id

string

name

required

Name

string

status

required

CampaignStatus

string

Allowed values: draft scrubbing ready running paused completed cancelled

agent_definition_id

required

Agent Definition Id

string

agent_version_id

Any of:

string

string

null

null

target

required

CampaignTarget

V1 campaigns target a contact list; a segment_id target joins at P2.

object

contact_list_id

required

Contact List Id

string

number_pool_id

required

Number Pool Id

string

telephony_account_id

required

Telephony Account Id

string

compliance_profile_id

Any of:

string

string

null

null

scrub_run_id

Any of:

string

string

null

null

max_attempts_per_contact

required

Max Attempts Per Contact

integer

concurrency_cap

Any of:

integer

integer

null

null

contacts_total

required

Contacts Total

integer

dialed

required

Dialed

integer

connected

required

Connected

integer

completed_goal

required

Completed Goal

integer

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

next_cursor

Any of:

string

string

null

null

has_more

Has More

boolean

Example

{
  "data": [
    {
      "status": "draft"
    }
  ],
  "has_more": false
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}