GET
/
campaigns
/
{campaign_id}
curl --request GET \
  --url https://api.puretalk.ai/api/campaigns/{campaign_id} \
  --header 'X-API-KEY: <api-key>'
{
  "msg": "<string>",
  "err": true,
  "results": {
    "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

Path Parameters

campaign_id
string
required

ID of campaign to return

Response

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