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>'
import requests

url = "https://api.puretalk.ai/api/campaigns/{campaign_id}/leads"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.puretalk.ai/api/campaigns/{campaign_id}/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.puretalk.ai/api/campaigns/{campaign_id}/leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.puretalk.ai/api/campaigns/{campaign_id}/leads"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.puretalk.ai/api/campaigns/{campaign_id}/leads")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.puretalk.ai/api/campaigns/{campaign_id}/leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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"
    }
  ]
}
{
  "err": false,
  "msg": "Error message"
}

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<int32>

The page number to return

limit
integer<int32>

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[]