Skip to main content
GET

Query Parameters

status
string
default:"All"
Filter by: draft, running, paused, completed, failed
limit
integer
default:"20"
Maximum number of campaigns to return
offset
integer
default:"0"
Pagination offset

Response 200

Response Fields

campaigns[].id
string
Campaign ID
campaigns[].name
string
Campaign name
campaigns[].status
string
draft, running, paused, completed, failed
campaigns[].type
string
voice or sms
campaigns[].total_contacts
integer
Total contacts in the campaign
campaigns[].completed
integer
Successfully reached contacts
campaigns[].failed
integer
Failed contact attempts

Errors

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
string | null
channel
string | null

Response

Successful Response