Get extracted leads
curl --request GET \
--url https://api.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results"
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.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results', 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.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results",
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.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results"
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.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results")
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{
"campaign_id": "<string>",
"leads": [
{
"id": "<string>",
"linkedin_url": "<string>",
"is_enriched": true,
"extracted_at": "<string>",
"linkedin_identifier": "<string>",
"linkedin_num_id": "<string>",
"public_profile_url": "<string>",
"input_url": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"headline": "<string>",
"summary": "<string>",
"about": "<string>",
"location": "<string>",
"city": "<string>",
"country": "<string>",
"country_code": "<string>",
"profile_picture_url": "<string>",
"profile_picture_url_large": "<string>",
"avatar": "<string>",
"background_picture_url": "<string>",
"banner_image": "<string>",
"default_avatar": true,
"company": "<string>",
"current_company": "<string>",
"current_company_id": "<string>",
"current_company_link": "<string>",
"job_position": "<string>",
"email": "<string>",
"emails": [
"<string>"
],
"phone": "<string>",
"phones": [
"<string>"
],
"websites": {},
"contact_info": {},
"connections": 123,
"connections_count": 123,
"followers": 123,
"follower_count": 123,
"shared_connections_count": 123,
"network_distance": "<string>",
"is_creator": true,
"is_hiring": true,
"is_influencer": true,
"is_open_profile": true,
"is_open_to_work": true,
"is_premium": true,
"can_send_inmail": true,
"experience": {},
"work_experience": {},
"education": {},
"educations_details": "<string>",
"certifications": {},
"courses": {},
"projects": {},
"publications": {},
"honors_and_awards": {},
"volunteering_experience": {},
"languages": {},
"skills": {},
"activity": {},
"posts": {},
"people_also_viewed": {},
"similar_profiles": {},
"recommendations": {},
"recommendations_count": 123,
"hashtags": {},
"bio_links": {},
"invitation": {},
"birthdate": {},
"primary_locale": {},
"memorialized_account": true
}
],
"total": 123,
"offset": 123,
"limit": 123,
"has_more": true
}Lead Extractor
Get Extracted Leads
Read paginated extraction results, optionally restricted to enriched profiles.
GET
/
v1
/
lead-extractor
/
campaigns
/
{id}
/
results
Get extracted leads
curl --request GET \
--url https://api.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results"
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.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results', 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.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results",
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.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results"
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.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sendpilot.ai/v1/lead-extractor/campaigns/{id}/results")
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{
"campaign_id": "<string>",
"leads": [
{
"id": "<string>",
"linkedin_url": "<string>",
"is_enriched": true,
"extracted_at": "<string>",
"linkedin_identifier": "<string>",
"linkedin_num_id": "<string>",
"public_profile_url": "<string>",
"input_url": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"headline": "<string>",
"summary": "<string>",
"about": "<string>",
"location": "<string>",
"city": "<string>",
"country": "<string>",
"country_code": "<string>",
"profile_picture_url": "<string>",
"profile_picture_url_large": "<string>",
"avatar": "<string>",
"background_picture_url": "<string>",
"banner_image": "<string>",
"default_avatar": true,
"company": "<string>",
"current_company": "<string>",
"current_company_id": "<string>",
"current_company_link": "<string>",
"job_position": "<string>",
"email": "<string>",
"emails": [
"<string>"
],
"phone": "<string>",
"phones": [
"<string>"
],
"websites": {},
"contact_info": {},
"connections": 123,
"connections_count": 123,
"followers": 123,
"follower_count": 123,
"shared_connections_count": 123,
"network_distance": "<string>",
"is_creator": true,
"is_hiring": true,
"is_influencer": true,
"is_open_profile": true,
"is_open_to_work": true,
"is_premium": true,
"can_send_inmail": true,
"experience": {},
"work_experience": {},
"education": {},
"educations_details": "<string>",
"certifications": {},
"courses": {},
"projects": {},
"publications": {},
"honors_and_awards": {},
"volunteering_experience": {},
"languages": {},
"skills": {},
"activity": {},
"posts": {},
"people_also_viewed": {},
"similar_profiles": {},
"recommendations": {},
"recommendations_count": 123,
"hashtags": {},
"bio_links": {},
"invitation": {},
"birthdate": {},
"primary_locale": {},
"memorialized_account": true
}
],
"total": 123,
"offset": 123,
"limit": 123,
"has_more": true
}Requires
leads:read. offset defaults to 0 and is capped at 10,000. limit defaults to 100 and is capped at 500. Set enriched_only=true to request enriched leads only.
The response includes campaign_id (the extraction job ID), leads, total, offset, limit, and has_more. It does not import those leads into an outreach campaign. Use Add Leads separately when ready.Authorizations
API key for authentication (prefix: sp_live_ or sp_test_)
Path Parameters
Campaign ID
Query Parameters
Maximum number of items to return
Required range:
1 <= x <= 500Offset for pagination (0-indexed)
Required range:
0 <= x <= 10000Return only leads with completed enrichment when true. Omitted or false returns all leads. Accepts true, false, 1, or 0.