Get Campaign Leads
curl --request GET \
--url https://app-api.walead.ai/api/v1/campaigns/{campaignId}/leads \
--header 'x-api-key: <api-key>'import requests
url = "https://app-api.walead.ai/api/v1/campaigns/{campaignId}/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://app-api.walead.ai/api/v1/campaigns/{campaignId}/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://app-api.walead.ai/api/v1/campaigns/{campaignId}/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://app-api.walead.ai/api/v1/campaigns/{campaignId}/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://app-api.walead.ai/api/v1/campaigns/{campaignId}/leads")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app-api.walead.ai/api/v1/campaigns/{campaignId}/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{
"campaignId": "abc123-def456-ghi789",
"total": 150,
"leads": [
{
"id": "lead-uuid-123",
"publicIdentifier": "john-doe-12345",
"linkedinUrl": "https://www.linkedin.com/in/john-doe-12345",
"entityUrn": null,
"firstName": "John",
"lastName": "Doe",
"name": "John Doe",
"email": "john.doe@example.com",
"phone": "+1234567890",
"companyName": "Example Corp",
"headline": "CEO at Example Corp",
"website": "https://example.com",
"summary": "Experienced executive with a passion for innovation...",
"profilePictureUrl": "https://media.licdn.com/dms/image/...",
"status": "verified",
"internalStatus": "waiting",
"currentStep": 0,
"customVariables": {
"city": "San Francisco",
"state": "California",
"jobTitle": "Chief Executive Officer",
"location": "San Francisco, California"
}
}
]
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}Leads
Get Campaign Leads
Retrieves all leads associated with a specific campaign
GET
/
v1
/
campaigns
/
{campaignId}
/
leads
Get Campaign Leads
curl --request GET \
--url https://app-api.walead.ai/api/v1/campaigns/{campaignId}/leads \
--header 'x-api-key: <api-key>'import requests
url = "https://app-api.walead.ai/api/v1/campaigns/{campaignId}/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://app-api.walead.ai/api/v1/campaigns/{campaignId}/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://app-api.walead.ai/api/v1/campaigns/{campaignId}/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://app-api.walead.ai/api/v1/campaigns/{campaignId}/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://app-api.walead.ai/api/v1/campaigns/{campaignId}/leads")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app-api.walead.ai/api/v1/campaigns/{campaignId}/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{
"campaignId": "abc123-def456-ghi789",
"total": 150,
"leads": [
{
"id": "lead-uuid-123",
"publicIdentifier": "john-doe-12345",
"linkedinUrl": "https://www.linkedin.com/in/john-doe-12345",
"entityUrn": null,
"firstName": "John",
"lastName": "Doe",
"name": "John Doe",
"email": "john.doe@example.com",
"phone": "+1234567890",
"companyName": "Example Corp",
"headline": "CEO at Example Corp",
"website": "https://example.com",
"summary": "Experienced executive with a passion for innovation...",
"profilePictureUrl": "https://media.licdn.com/dms/image/...",
"status": "verified",
"internalStatus": "waiting",
"currentStep": 0,
"customVariables": {
"city": "San Francisco",
"state": "California",
"jobTitle": "Chief Executive Officer",
"location": "San Francisco, California"
}
}
]
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}Overview
Retrieves all leads associated with a specific campaign. This endpoint returns detailed information about each lead, including their status, LinkedIn profile data, and campaign progress.Response Structure
The response includes:- campaignId: The campaign identifier
- total: Total number of leads in the campaign
- leads: Array of lead objects with complete information
- Profile Information: Name, LinkedIn URL, email, phone, company
- Status Fields: Current status and internal processing status
- Campaign Progress: Current step in the sequence
- Custom Variables: Additional data collected for personalization
Use Cases
- Monitor campaign progress and lead statuses
- Export campaign leads for analysis
- Track which leads have been contacted
- Identify leads requiring follow-up
Authorizations
API key for authentication. Generate from your WaLead dashboard.
Path Parameters
Campaign ID