Skip to main content
GET
/
campaigns
cURL
curl --request GET \
  --url https://api.puretalk.ai/api/campaigns \
  --header 'X-API-KEY: <api-key>'
{
  "msg": "Campaigns retrieved successfully",
  "err": false,
  "results": {
    "count": 100,
    "campaigns": [
      {
        "ai_assistant": {
          "assistant_id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "My Assistant",
          "variables": [
            "name"
          ]
        },
        "schedules": [
          {
            "campaign_schedule_id": "123e4567-e89b-12d3-a456-426614174000",
            "day": "Monday",
            "start_time": "10:00",
            "end_time": "11:00"
          }
        ],
        "campaign_id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "call",
        "name": "My Campaign",
        "start_date": "2021-01-01",
        "end_date": "2021-01-01",
        "status": "active",
        "created_at": "2021-01-01",
        "updated_at": "2021-01-01",
        "total_tasks": 100,
        "completed_tasks": 100,
        "pending_tasks": 100
      }
    ]
  }
}

Authorizations

​
X-API-KEY
string
header
required

Authorization header containing API key. You can find your API key in the dashboard under 'API Keys'.

Query Parameters

​
page
integer<int32>

The page number to return

​
limit
integer<int32>

The maximum number of results to return

Response

Campaigns response

​
msg
string

Message from the API

Example:

"Campaigns retrieved successfully"

​
err
boolean

Indicates if the response is an error

Example:

false

​
results
object