List Leads in Campaign
curl --request GET \
--url https://api.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list', 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.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"leads": [
{
"id": "Vm9pY2VDYW1wYWlnbkxlYWQ6YWJj",
"phone_number": "+14155552671",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane@example.com",
"source": "API",
"custom_fields": {
"company": "Acme"
},
"call_status": "IDLE",
"call_error_reason": null,
"answered": false,
"answer_type": "",
"attempts_made": 0,
"do_not_call": false,
"invalid": false,
"invalid_reason": null,
"priority": 0,
"next_attempt_after": null,
"answered_at": null,
"created_at": "2025-01-15T10:00:00+00:00",
"updated_at": "2025-01-15T10:00:00+00:00"
}
],
"page_info": {
"total_count": 100,
"limit": 50,
"offset": 0,
"has_next_page": true,
"has_previous_page": false
}
}Leads (v2)
List Leads in Voice Campaign
Returns all leads for the specified campaign, ordered by most recently created first.
Authentication
All requests require an Authorization header using Bearer token authentication:
Authorization: Bearer <api_key>
GET
/
api
/
v2
/
voice-campaigns
/
{campaign_id}
/
leads
/
list
List Leads in Campaign
curl --request GET \
--url https://api.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list', 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.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"leads": [
{
"id": "Vm9pY2VDYW1wYWlnbkxlYWQ6YWJj",
"phone_number": "+14155552671",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane@example.com",
"source": "API",
"custom_fields": {
"company": "Acme"
},
"call_status": "IDLE",
"call_error_reason": null,
"answered": false,
"answer_type": "",
"attempts_made": 0,
"do_not_call": false,
"invalid": false,
"invalid_reason": null,
"priority": 0,
"next_attempt_after": null,
"answered_at": null,
"created_at": "2025-01-15T10:00:00+00:00",
"updated_at": "2025-01-15T10:00:00+00:00"
}
],
"page_info": {
"total_count": 100,
"limit": 50,
"offset": 0,
"has_next_page": true,
"has_previous_page": false
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Campaign global ID. Required.
Example:
"VnVpc2VDYW1wYWlnbjoxMjM0"
Query Parameters
Maximum number of leads to return. Default 50, maximum 200.
Required range:
1 <= x <= 200Number of leads to skip from the start of the result set. Default 0.
Required range:
x >= 0Was this page helpful?
⌘I

