Skip to main content
GET
cURL

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