GET
/
campaigns
curl --request GET \
  --url https://api.puretalk.ai/api/campaigns \
  --header 'X-API-KEY: <api-key>'
{
  "msg": "<string>",
  "err": true,
  "results": {
    "count": 123,
    "campaigns": [
      {
        "ai_assistant": {
          "assistant_id": "<string>",
          "name": "<string>",
          "variables": [
            "<string>"
          ]
        },
        "schedules": [
          {
            "campaign_schedule_id": "<string>",
            "day": "<string>",
            "start_time": "<string>",
            "end_time": "<string>"
          }
        ],
        "campaign_id": "<string>",
        "type": "<string>",
        "name": "<string>",
        "start_date": "2023-12-25",
        "end_date": "2023-12-25",
        "status": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "total_tasks": 123,
        "completed_tasks": 123,
        "pending_tasks": 123
      }
    ]
  }
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

page
integer

The page number to return

limit
integer

The maximum number of results to return

Response

200
application/json
Campaigns response
msg
string
err
boolean
results
object