Skip to main content
GET
/
api
/
v1
/
campaign
/
list
Read Campaign List
curl --request GET \
  --url 'https://api.example.com/api/v1/campaign/list?api_key='
{
  "data": {
    "items": [
      {
        "name": "<string>",
        "type": "outbound_call",
        "start_time": "2023-11-07T05:31:56Z",
        "interval": 123,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "attributes": {},
        "status": "not_started",
        "execution_weekdays": [],
        "time_window_start": "<string>",
        "time_window_end": "<string>",
        "time_zone": "UTC",
        "enabled": false,
        "contacts": [],
        "widget_name": "<string>",
        "contact_status_counts": {}
      }
    ],
    "total": 1,
    "page": 2,
    "size": 2,
    "pages": 1,
    "previous_page": 123,
    "next_page": 123
  },
  "message": "",
  "meta": {}
}

Authorizations

​
api_key
string
query
required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
size
integer
default:50
Required range: 1 <= x <= 100

Response

Successful Response

​
data
PageBase[ICampaignListRead] · object
required
​
message
string | null
default:""
​
meta
Meta · object