Skip to main content
GET
/
campaigns
/
{campaign_id}
/
leads
cURL
curl --request GET \
  --url https://api.puretalk.ai/api/campaigns/{campaign_id}/leads \
  --header 'X-API-KEY: <api-key>'
{
  "count": 100,
  "next": "https://api.puretalk.ai/api/campaigns/123e4567-e89b-12d3-a456-426614174000/leads?page=2",
  "previous": "https://api.puretalk.ai/api/campaigns/123e4567-e89b-12d3-a456-426614174000/leads?page=1",
  "results": [
    {
      "to_number": "+1234567890",
      "is_completed": false,
      "variables": [
        {
          "var_name": "name",
          "var_value": "John Doe"
        }
      ],
      "call_id": "<string>",
      "completed_at": "2021-01-01"
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

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

Path Parameters

campaign_id
string<uuid>
required

ID of campaign to return leads

Query Parameters

page
integer

The page number to return

limit
integer

The maximum number of results to return

Response

Campaign leads response

count
integer

Total number of leads

Example:

100

next
string<uri> | null

Next page URL

Example:

"https://api.puretalk.ai/api/campaigns/123e4567-e89b-12d3-a456-426614174000/leads?page=2"

previous
string<uri> | null

Previous page URL

Example:

"https://api.puretalk.ai/api/campaigns/123e4567-e89b-12d3-a456-426614174000/leads?page=1"

results
object[]
I