Create a lead database search
curl --request POST \
--url https://api.sendpilot.ai/v1/lead-database/searches \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"filters": {
"member_full_name": "<string>",
"job_titles": [
"<string>"
],
"excluded_job_titles": [
"<string>"
],
"member_skills": [
"<string>"
],
"excluded_member_skills": [
"<string>"
],
"member_linkedin_username": [
"<string>"
],
"excluded_member_linkedin_username": [
"<string>"
],
"locations": [
"<string>"
],
"excluded_locations": [
"<string>"
],
"member_description": [
"<string>"
],
"excluded_member_description": [
"<string>"
],
"seniority_levels": [],
"excluded_seniority_levels": [],
"member_department": [
"<string>"
],
"excluded_member_department": [
"<string>"
],
"member_certifications": [
"<string>"
],
"excluded_member_certifications": [
"<string>"
],
"min_total_experience_duration_months": 1,
"max_total_experience_duration_months": 1,
"min_job_duration_months": 1,
"max_job_duration_months": 1,
"companies": [
"<string>"
],
"excluded_companies": [
"<string>"
],
"bulk_domains": "<string>",
"excluded_bulk_domains": "<string>",
"company_linkedin_username": [
"<string>"
],
"excluded_company_linkedin_username": [
"<string>"
],
"company_type": [],
"excluded_company_type": [],
"industries": [
"<string>"
],
"excluded_industries": [
"<string>"
],
"is_mapped_industries_strict": true,
"company_sizes": [],
"excluded_company_sizes": [],
"hq_location": [
"<string>"
],
"excluded_hq_location": [
"<string>"
],
"sic_codes": [
{
"label": "<string>",
"value": "<string>"
}
],
"excluded_sic_codes": [
"<string>"
],
"naics_codes": [
{
"label": "<string>",
"value": "<string>"
}
],
"excluded_naics_codes": [
"<string>"
],
"keywords": [
"<string>"
],
"excluded_keywords": [
"<string>"
],
"last_funding_round_name": [],
"ownership_status": [],
"min_last_funding_round_amount_raised": 1,
"max_last_funding_round_amount_raised": 1,
"ipo_start_date": "<string>",
"ipo_end_date": "<string>",
"acquired_start_date": "<string>",
"acquired_end_date": "<string>",
"min_revenue_annual": 1,
"max_revenue_annual": 1,
"min_total_website_visits_monthly": 1,
"max_total_website_visits_monthly": 1,
"min_rank_global": 1,
"max_rank_global": 1,
"min_rank_country": 1,
"max_rank_country": 1,
"min_rank_category": 1,
"max_rank_category": 1,
"min_bounce_rate": 50,
"max_bounce_rate": 50,
"min_pages_per_visit": 1,
"max_pages_per_visit": 1,
"min_average_visit_duration_seconds": 1,
"max_average_visit_duration_seconds": 1,
"top_topics": [
"<string>"
],
"excluded_top_topics": [
"<string>"
],
"technologies_used": [
"<string>"
],
"excluded_technologies_used": [
"<string>"
],
"pricing_available": true,
"demo_available": true,
"documentation_exist": true,
"free_trial_available": true,
"is_downloadable": true,
"mobile_apps_exist": true,
"online_reviews_exist": true,
"min_company_employee_reviews_aggregate_score": 1,
"max_company_employee_reviews_aggregate_score": 1,
"job_posting_title": [
"<string>"
],
"excluded_job_posting_title": [
"<string>"
],
"job_posting_location": [
"<string>"
],
"excluded_job_posting_location": [
"<string>"
],
"excluded_job_posting_functions": [
"<string>"
],
"job_posting_start_date": "<string>",
"job_posting_end_date": "<string>",
"job_posting_type": [],
"job_posting_seniority": [],
"experimental_industries": [
"<string>"
],
"excluded_experimental_industries": [
"<string>"
],
"experimental_member_department": [
"<string>"
],
"excluded_experimental_department": [
"<string>"
]
},
"limit": 2,
"webhook_url": "https://my-app.example.com/webhooks/sendpilot"
}
'import requests
url = "https://api.sendpilot.ai/v1/lead-database/searches"
payload = {
"name": "<string>",
"filters": {
"member_full_name": "<string>",
"job_titles": ["<string>"],
"excluded_job_titles": ["<string>"],
"member_skills": ["<string>"],
"excluded_member_skills": ["<string>"],
"member_linkedin_username": ["<string>"],
"excluded_member_linkedin_username": ["<string>"],
"locations": ["<string>"],
"excluded_locations": ["<string>"],
"member_description": ["<string>"],
"excluded_member_description": ["<string>"],
"seniority_levels": [],
"excluded_seniority_levels": [],
"member_department": ["<string>"],
"excluded_member_department": ["<string>"],
"member_certifications": ["<string>"],
"excluded_member_certifications": ["<string>"],
"min_total_experience_duration_months": 1,
"max_total_experience_duration_months": 1,
"min_job_duration_months": 1,
"max_job_duration_months": 1,
"companies": ["<string>"],
"excluded_companies": ["<string>"],
"bulk_domains": "<string>",
"excluded_bulk_domains": "<string>",
"company_linkedin_username": ["<string>"],
"excluded_company_linkedin_username": ["<string>"],
"company_type": [],
"excluded_company_type": [],
"industries": ["<string>"],
"excluded_industries": ["<string>"],
"is_mapped_industries_strict": True,
"company_sizes": [],
"excluded_company_sizes": [],
"hq_location": ["<string>"],
"excluded_hq_location": ["<string>"],
"sic_codes": [
{
"label": "<string>",
"value": "<string>"
}
],
"excluded_sic_codes": ["<string>"],
"naics_codes": [
{
"label": "<string>",
"value": "<string>"
}
],
"excluded_naics_codes": ["<string>"],
"keywords": ["<string>"],
"excluded_keywords": ["<string>"],
"last_funding_round_name": [],
"ownership_status": [],
"min_last_funding_round_amount_raised": 1,
"max_last_funding_round_amount_raised": 1,
"ipo_start_date": "<string>",
"ipo_end_date": "<string>",
"acquired_start_date": "<string>",
"acquired_end_date": "<string>",
"min_revenue_annual": 1,
"max_revenue_annual": 1,
"min_total_website_visits_monthly": 1,
"max_total_website_visits_monthly": 1,
"min_rank_global": 1,
"max_rank_global": 1,
"min_rank_country": 1,
"max_rank_country": 1,
"min_rank_category": 1,
"max_rank_category": 1,
"min_bounce_rate": 50,
"max_bounce_rate": 50,
"min_pages_per_visit": 1,
"max_pages_per_visit": 1,
"min_average_visit_duration_seconds": 1,
"max_average_visit_duration_seconds": 1,
"top_topics": ["<string>"],
"excluded_top_topics": ["<string>"],
"technologies_used": ["<string>"],
"excluded_technologies_used": ["<string>"],
"pricing_available": True,
"demo_available": True,
"documentation_exist": True,
"free_trial_available": True,
"is_downloadable": True,
"mobile_apps_exist": True,
"online_reviews_exist": True,
"min_company_employee_reviews_aggregate_score": 1,
"max_company_employee_reviews_aggregate_score": 1,
"job_posting_title": ["<string>"],
"excluded_job_posting_title": ["<string>"],
"job_posting_location": ["<string>"],
"excluded_job_posting_location": ["<string>"],
"excluded_job_posting_functions": ["<string>"],
"job_posting_start_date": "<string>",
"job_posting_end_date": "<string>",
"job_posting_type": [],
"job_posting_seniority": [],
"experimental_industries": ["<string>"],
"excluded_experimental_industries": ["<string>"],
"experimental_member_department": ["<string>"],
"excluded_experimental_department": ["<string>"]
},
"limit": 2,
"webhook_url": "https://my-app.example.com/webhooks/sendpilot"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
filters: {
member_full_name: '<string>',
job_titles: ['<string>'],
excluded_job_titles: ['<string>'],
member_skills: ['<string>'],
excluded_member_skills: ['<string>'],
member_linkedin_username: ['<string>'],
excluded_member_linkedin_username: ['<string>'],
locations: ['<string>'],
excluded_locations: ['<string>'],
member_description: ['<string>'],
excluded_member_description: ['<string>'],
seniority_levels: [],
excluded_seniority_levels: [],
member_department: ['<string>'],
excluded_member_department: ['<string>'],
member_certifications: ['<string>'],
excluded_member_certifications: ['<string>'],
min_total_experience_duration_months: 1,
max_total_experience_duration_months: 1,
min_job_duration_months: 1,
max_job_duration_months: 1,
companies: ['<string>'],
excluded_companies: ['<string>'],
bulk_domains: '<string>',
excluded_bulk_domains: '<string>',
company_linkedin_username: ['<string>'],
excluded_company_linkedin_username: ['<string>'],
company_type: [],
excluded_company_type: [],
industries: ['<string>'],
excluded_industries: ['<string>'],
is_mapped_industries_strict: true,
company_sizes: [],
excluded_company_sizes: [],
hq_location: ['<string>'],
excluded_hq_location: ['<string>'],
sic_codes: [{label: '<string>', value: '<string>'}],
excluded_sic_codes: ['<string>'],
naics_codes: [{label: '<string>', value: '<string>'}],
excluded_naics_codes: ['<string>'],
keywords: ['<string>'],
excluded_keywords: ['<string>'],
last_funding_round_name: [],
ownership_status: [],
min_last_funding_round_amount_raised: 1,
max_last_funding_round_amount_raised: 1,
ipo_start_date: '<string>',
ipo_end_date: '<string>',
acquired_start_date: '<string>',
acquired_end_date: '<string>',
min_revenue_annual: 1,
max_revenue_annual: 1,
min_total_website_visits_monthly: 1,
max_total_website_visits_monthly: 1,
min_rank_global: 1,
max_rank_global: 1,
min_rank_country: 1,
max_rank_country: 1,
min_rank_category: 1,
max_rank_category: 1,
min_bounce_rate: 50,
max_bounce_rate: 50,
min_pages_per_visit: 1,
max_pages_per_visit: 1,
min_average_visit_duration_seconds: 1,
max_average_visit_duration_seconds: 1,
top_topics: ['<string>'],
excluded_top_topics: ['<string>'],
technologies_used: ['<string>'],
excluded_technologies_used: ['<string>'],
pricing_available: true,
demo_available: true,
documentation_exist: true,
free_trial_available: true,
is_downloadable: true,
mobile_apps_exist: true,
online_reviews_exist: true,
min_company_employee_reviews_aggregate_score: 1,
max_company_employee_reviews_aggregate_score: 1,
job_posting_title: ['<string>'],
excluded_job_posting_title: ['<string>'],
job_posting_location: ['<string>'],
excluded_job_posting_location: ['<string>'],
excluded_job_posting_functions: ['<string>'],
job_posting_start_date: '<string>',
job_posting_end_date: '<string>',
job_posting_type: [],
job_posting_seniority: [],
experimental_industries: ['<string>'],
excluded_experimental_industries: ['<string>'],
experimental_member_department: ['<string>'],
excluded_experimental_department: ['<string>']
},
limit: 2,
webhook_url: 'https://my-app.example.com/webhooks/sendpilot'
})
};
fetch('https://api.sendpilot.ai/v1/lead-database/searches', 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-database/searches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'filters' => [
'member_full_name' => '<string>',
'job_titles' => [
'<string>'
],
'excluded_job_titles' => [
'<string>'
],
'member_skills' => [
'<string>'
],
'excluded_member_skills' => [
'<string>'
],
'member_linkedin_username' => [
'<string>'
],
'excluded_member_linkedin_username' => [
'<string>'
],
'locations' => [
'<string>'
],
'excluded_locations' => [
'<string>'
],
'member_description' => [
'<string>'
],
'excluded_member_description' => [
'<string>'
],
'seniority_levels' => [
],
'excluded_seniority_levels' => [
],
'member_department' => [
'<string>'
],
'excluded_member_department' => [
'<string>'
],
'member_certifications' => [
'<string>'
],
'excluded_member_certifications' => [
'<string>'
],
'min_total_experience_duration_months' => 1,
'max_total_experience_duration_months' => 1,
'min_job_duration_months' => 1,
'max_job_duration_months' => 1,
'companies' => [
'<string>'
],
'excluded_companies' => [
'<string>'
],
'bulk_domains' => '<string>',
'excluded_bulk_domains' => '<string>',
'company_linkedin_username' => [
'<string>'
],
'excluded_company_linkedin_username' => [
'<string>'
],
'company_type' => [
],
'excluded_company_type' => [
],
'industries' => [
'<string>'
],
'excluded_industries' => [
'<string>'
],
'is_mapped_industries_strict' => true,
'company_sizes' => [
],
'excluded_company_sizes' => [
],
'hq_location' => [
'<string>'
],
'excluded_hq_location' => [
'<string>'
],
'sic_codes' => [
[
'label' => '<string>',
'value' => '<string>'
]
],
'excluded_sic_codes' => [
'<string>'
],
'naics_codes' => [
[
'label' => '<string>',
'value' => '<string>'
]
],
'excluded_naics_codes' => [
'<string>'
],
'keywords' => [
'<string>'
],
'excluded_keywords' => [
'<string>'
],
'last_funding_round_name' => [
],
'ownership_status' => [
],
'min_last_funding_round_amount_raised' => 1,
'max_last_funding_round_amount_raised' => 1,
'ipo_start_date' => '<string>',
'ipo_end_date' => '<string>',
'acquired_start_date' => '<string>',
'acquired_end_date' => '<string>',
'min_revenue_annual' => 1,
'max_revenue_annual' => 1,
'min_total_website_visits_monthly' => 1,
'max_total_website_visits_monthly' => 1,
'min_rank_global' => 1,
'max_rank_global' => 1,
'min_rank_country' => 1,
'max_rank_country' => 1,
'min_rank_category' => 1,
'max_rank_category' => 1,
'min_bounce_rate' => 50,
'max_bounce_rate' => 50,
'min_pages_per_visit' => 1,
'max_pages_per_visit' => 1,
'min_average_visit_duration_seconds' => 1,
'max_average_visit_duration_seconds' => 1,
'top_topics' => [
'<string>'
],
'excluded_top_topics' => [
'<string>'
],
'technologies_used' => [
'<string>'
],
'excluded_technologies_used' => [
'<string>'
],
'pricing_available' => true,
'demo_available' => true,
'documentation_exist' => true,
'free_trial_available' => true,
'is_downloadable' => true,
'mobile_apps_exist' => true,
'online_reviews_exist' => true,
'min_company_employee_reviews_aggregate_score' => 1,
'max_company_employee_reviews_aggregate_score' => 1,
'job_posting_title' => [
'<string>'
],
'excluded_job_posting_title' => [
'<string>'
],
'job_posting_location' => [
'<string>'
],
'excluded_job_posting_location' => [
'<string>'
],
'excluded_job_posting_functions' => [
'<string>'
],
'job_posting_start_date' => '<string>',
'job_posting_end_date' => '<string>',
'job_posting_type' => [
],
'job_posting_seniority' => [
],
'experimental_industries' => [
'<string>'
],
'excluded_experimental_industries' => [
'<string>'
],
'experimental_member_department' => [
'<string>'
],
'excluded_experimental_department' => [
'<string>'
]
],
'limit' => 2,
'webhook_url' => 'https://my-app.example.com/webhooks/sendpilot'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sendpilot.ai/v1/lead-database/searches"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"filters\": {\n \"member_full_name\": \"<string>\",\n \"job_titles\": [\n \"<string>\"\n ],\n \"excluded_job_titles\": [\n \"<string>\"\n ],\n \"member_skills\": [\n \"<string>\"\n ],\n \"excluded_member_skills\": [\n \"<string>\"\n ],\n \"member_linkedin_username\": [\n \"<string>\"\n ],\n \"excluded_member_linkedin_username\": [\n \"<string>\"\n ],\n \"locations\": [\n \"<string>\"\n ],\n \"excluded_locations\": [\n \"<string>\"\n ],\n \"member_description\": [\n \"<string>\"\n ],\n \"excluded_member_description\": [\n \"<string>\"\n ],\n \"seniority_levels\": [],\n \"excluded_seniority_levels\": [],\n \"member_department\": [\n \"<string>\"\n ],\n \"excluded_member_department\": [\n \"<string>\"\n ],\n \"member_certifications\": [\n \"<string>\"\n ],\n \"excluded_member_certifications\": [\n \"<string>\"\n ],\n \"min_total_experience_duration_months\": 1,\n \"max_total_experience_duration_months\": 1,\n \"min_job_duration_months\": 1,\n \"max_job_duration_months\": 1,\n \"companies\": [\n \"<string>\"\n ],\n \"excluded_companies\": [\n \"<string>\"\n ],\n \"bulk_domains\": \"<string>\",\n \"excluded_bulk_domains\": \"<string>\",\n \"company_linkedin_username\": [\n \"<string>\"\n ],\n \"excluded_company_linkedin_username\": [\n \"<string>\"\n ],\n \"company_type\": [],\n \"excluded_company_type\": [],\n \"industries\": [\n \"<string>\"\n ],\n \"excluded_industries\": [\n \"<string>\"\n ],\n \"is_mapped_industries_strict\": true,\n \"company_sizes\": [],\n \"excluded_company_sizes\": [],\n \"hq_location\": [\n \"<string>\"\n ],\n \"excluded_hq_location\": [\n \"<string>\"\n ],\n \"sic_codes\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"excluded_sic_codes\": [\n \"<string>\"\n ],\n \"naics_codes\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"excluded_naics_codes\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"<string>\"\n ],\n \"excluded_keywords\": [\n \"<string>\"\n ],\n \"last_funding_round_name\": [],\n \"ownership_status\": [],\n \"min_last_funding_round_amount_raised\": 1,\n \"max_last_funding_round_amount_raised\": 1,\n \"ipo_start_date\": \"<string>\",\n \"ipo_end_date\": \"<string>\",\n \"acquired_start_date\": \"<string>\",\n \"acquired_end_date\": \"<string>\",\n \"min_revenue_annual\": 1,\n \"max_revenue_annual\": 1,\n \"min_total_website_visits_monthly\": 1,\n \"max_total_website_visits_monthly\": 1,\n \"min_rank_global\": 1,\n \"max_rank_global\": 1,\n \"min_rank_country\": 1,\n \"max_rank_country\": 1,\n \"min_rank_category\": 1,\n \"max_rank_category\": 1,\n \"min_bounce_rate\": 50,\n \"max_bounce_rate\": 50,\n \"min_pages_per_visit\": 1,\n \"max_pages_per_visit\": 1,\n \"min_average_visit_duration_seconds\": 1,\n \"max_average_visit_duration_seconds\": 1,\n \"top_topics\": [\n \"<string>\"\n ],\n \"excluded_top_topics\": [\n \"<string>\"\n ],\n \"technologies_used\": [\n \"<string>\"\n ],\n \"excluded_technologies_used\": [\n \"<string>\"\n ],\n \"pricing_available\": true,\n \"demo_available\": true,\n \"documentation_exist\": true,\n \"free_trial_available\": true,\n \"is_downloadable\": true,\n \"mobile_apps_exist\": true,\n \"online_reviews_exist\": true,\n \"min_company_employee_reviews_aggregate_score\": 1,\n \"max_company_employee_reviews_aggregate_score\": 1,\n \"job_posting_title\": [\n \"<string>\"\n ],\n \"excluded_job_posting_title\": [\n \"<string>\"\n ],\n \"job_posting_location\": [\n \"<string>\"\n ],\n \"excluded_job_posting_location\": [\n \"<string>\"\n ],\n \"excluded_job_posting_functions\": [\n \"<string>\"\n ],\n \"job_posting_start_date\": \"<string>\",\n \"job_posting_end_date\": \"<string>\",\n \"job_posting_type\": [],\n \"job_posting_seniority\": [],\n \"experimental_industries\": [\n \"<string>\"\n ],\n \"excluded_experimental_industries\": [\n \"<string>\"\n ],\n \"experimental_member_department\": [\n \"<string>\"\n ],\n \"excluded_experimental_department\": [\n \"<string>\"\n ]\n },\n \"limit\": 2,\n \"webhook_url\": \"https://my-app.example.com/webhooks/sendpilot\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sendpilot.ai/v1/lead-database/searches")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"filters\": {\n \"member_full_name\": \"<string>\",\n \"job_titles\": [\n \"<string>\"\n ],\n \"excluded_job_titles\": [\n \"<string>\"\n ],\n \"member_skills\": [\n \"<string>\"\n ],\n \"excluded_member_skills\": [\n \"<string>\"\n ],\n \"member_linkedin_username\": [\n \"<string>\"\n ],\n \"excluded_member_linkedin_username\": [\n \"<string>\"\n ],\n \"locations\": [\n \"<string>\"\n ],\n \"excluded_locations\": [\n \"<string>\"\n ],\n \"member_description\": [\n \"<string>\"\n ],\n \"excluded_member_description\": [\n \"<string>\"\n ],\n \"seniority_levels\": [],\n \"excluded_seniority_levels\": [],\n \"member_department\": [\n \"<string>\"\n ],\n \"excluded_member_department\": [\n \"<string>\"\n ],\n \"member_certifications\": [\n \"<string>\"\n ],\n \"excluded_member_certifications\": [\n \"<string>\"\n ],\n \"min_total_experience_duration_months\": 1,\n \"max_total_experience_duration_months\": 1,\n \"min_job_duration_months\": 1,\n \"max_job_duration_months\": 1,\n \"companies\": [\n \"<string>\"\n ],\n \"excluded_companies\": [\n \"<string>\"\n ],\n \"bulk_domains\": \"<string>\",\n \"excluded_bulk_domains\": \"<string>\",\n \"company_linkedin_username\": [\n \"<string>\"\n ],\n \"excluded_company_linkedin_username\": [\n \"<string>\"\n ],\n \"company_type\": [],\n \"excluded_company_type\": [],\n \"industries\": [\n \"<string>\"\n ],\n \"excluded_industries\": [\n \"<string>\"\n ],\n \"is_mapped_industries_strict\": true,\n \"company_sizes\": [],\n \"excluded_company_sizes\": [],\n \"hq_location\": [\n \"<string>\"\n ],\n \"excluded_hq_location\": [\n \"<string>\"\n ],\n \"sic_codes\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"excluded_sic_codes\": [\n \"<string>\"\n ],\n \"naics_codes\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"excluded_naics_codes\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"<string>\"\n ],\n \"excluded_keywords\": [\n \"<string>\"\n ],\n \"last_funding_round_name\": [],\n \"ownership_status\": [],\n \"min_last_funding_round_amount_raised\": 1,\n \"max_last_funding_round_amount_raised\": 1,\n \"ipo_start_date\": \"<string>\",\n \"ipo_end_date\": \"<string>\",\n \"acquired_start_date\": \"<string>\",\n \"acquired_end_date\": \"<string>\",\n \"min_revenue_annual\": 1,\n \"max_revenue_annual\": 1,\n \"min_total_website_visits_monthly\": 1,\n \"max_total_website_visits_monthly\": 1,\n \"min_rank_global\": 1,\n \"max_rank_global\": 1,\n \"min_rank_country\": 1,\n \"max_rank_country\": 1,\n \"min_rank_category\": 1,\n \"max_rank_category\": 1,\n \"min_bounce_rate\": 50,\n \"max_bounce_rate\": 50,\n \"min_pages_per_visit\": 1,\n \"max_pages_per_visit\": 1,\n \"min_average_visit_duration_seconds\": 1,\n \"max_average_visit_duration_seconds\": 1,\n \"top_topics\": [\n \"<string>\"\n ],\n \"excluded_top_topics\": [\n \"<string>\"\n ],\n \"technologies_used\": [\n \"<string>\"\n ],\n \"excluded_technologies_used\": [\n \"<string>\"\n ],\n \"pricing_available\": true,\n \"demo_available\": true,\n \"documentation_exist\": true,\n \"free_trial_available\": true,\n \"is_downloadable\": true,\n \"mobile_apps_exist\": true,\n \"online_reviews_exist\": true,\n \"min_company_employee_reviews_aggregate_score\": 1,\n \"max_company_employee_reviews_aggregate_score\": 1,\n \"job_posting_title\": [\n \"<string>\"\n ],\n \"excluded_job_posting_title\": [\n \"<string>\"\n ],\n \"job_posting_location\": [\n \"<string>\"\n ],\n \"excluded_job_posting_location\": [\n \"<string>\"\n ],\n \"excluded_job_posting_functions\": [\n \"<string>\"\n ],\n \"job_posting_start_date\": \"<string>\",\n \"job_posting_end_date\": \"<string>\",\n \"job_posting_type\": [],\n \"job_posting_seniority\": [],\n \"experimental_industries\": [\n \"<string>\"\n ],\n \"excluded_experimental_industries\": [\n \"<string>\"\n ],\n \"experimental_member_department\": [\n \"<string>\"\n ],\n \"excluded_experimental_department\": [\n \"<string>\"\n ]\n },\n \"limit\": 2,\n \"webhook_url\": \"https://my-app.example.com/webhooks/sendpilot\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sendpilot.ai/v1/lead-database/searches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"filters\": {\n \"member_full_name\": \"<string>\",\n \"job_titles\": [\n \"<string>\"\n ],\n \"excluded_job_titles\": [\n \"<string>\"\n ],\n \"member_skills\": [\n \"<string>\"\n ],\n \"excluded_member_skills\": [\n \"<string>\"\n ],\n \"member_linkedin_username\": [\n \"<string>\"\n ],\n \"excluded_member_linkedin_username\": [\n \"<string>\"\n ],\n \"locations\": [\n \"<string>\"\n ],\n \"excluded_locations\": [\n \"<string>\"\n ],\n \"member_description\": [\n \"<string>\"\n ],\n \"excluded_member_description\": [\n \"<string>\"\n ],\n \"seniority_levels\": [],\n \"excluded_seniority_levels\": [],\n \"member_department\": [\n \"<string>\"\n ],\n \"excluded_member_department\": [\n \"<string>\"\n ],\n \"member_certifications\": [\n \"<string>\"\n ],\n \"excluded_member_certifications\": [\n \"<string>\"\n ],\n \"min_total_experience_duration_months\": 1,\n \"max_total_experience_duration_months\": 1,\n \"min_job_duration_months\": 1,\n \"max_job_duration_months\": 1,\n \"companies\": [\n \"<string>\"\n ],\n \"excluded_companies\": [\n \"<string>\"\n ],\n \"bulk_domains\": \"<string>\",\n \"excluded_bulk_domains\": \"<string>\",\n \"company_linkedin_username\": [\n \"<string>\"\n ],\n \"excluded_company_linkedin_username\": [\n \"<string>\"\n ],\n \"company_type\": [],\n \"excluded_company_type\": [],\n \"industries\": [\n \"<string>\"\n ],\n \"excluded_industries\": [\n \"<string>\"\n ],\n \"is_mapped_industries_strict\": true,\n \"company_sizes\": [],\n \"excluded_company_sizes\": [],\n \"hq_location\": [\n \"<string>\"\n ],\n \"excluded_hq_location\": [\n \"<string>\"\n ],\n \"sic_codes\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"excluded_sic_codes\": [\n \"<string>\"\n ],\n \"naics_codes\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"excluded_naics_codes\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"<string>\"\n ],\n \"excluded_keywords\": [\n \"<string>\"\n ],\n \"last_funding_round_name\": [],\n \"ownership_status\": [],\n \"min_last_funding_round_amount_raised\": 1,\n \"max_last_funding_round_amount_raised\": 1,\n \"ipo_start_date\": \"<string>\",\n \"ipo_end_date\": \"<string>\",\n \"acquired_start_date\": \"<string>\",\n \"acquired_end_date\": \"<string>\",\n \"min_revenue_annual\": 1,\n \"max_revenue_annual\": 1,\n \"min_total_website_visits_monthly\": 1,\n \"max_total_website_visits_monthly\": 1,\n \"min_rank_global\": 1,\n \"max_rank_global\": 1,\n \"min_rank_country\": 1,\n \"max_rank_country\": 1,\n \"min_rank_category\": 1,\n \"max_rank_category\": 1,\n \"min_bounce_rate\": 50,\n \"max_bounce_rate\": 50,\n \"min_pages_per_visit\": 1,\n \"max_pages_per_visit\": 1,\n \"min_average_visit_duration_seconds\": 1,\n \"max_average_visit_duration_seconds\": 1,\n \"top_topics\": [\n \"<string>\"\n ],\n \"excluded_top_topics\": [\n \"<string>\"\n ],\n \"technologies_used\": [\n \"<string>\"\n ],\n \"excluded_technologies_used\": [\n \"<string>\"\n ],\n \"pricing_available\": true,\n \"demo_available\": true,\n \"documentation_exist\": true,\n \"free_trial_available\": true,\n \"is_downloadable\": true,\n \"mobile_apps_exist\": true,\n \"online_reviews_exist\": true,\n \"min_company_employee_reviews_aggregate_score\": 1,\n \"max_company_employee_reviews_aggregate_score\": 1,\n \"job_posting_title\": [\n \"<string>\"\n ],\n \"excluded_job_posting_title\": [\n \"<string>\"\n ],\n \"job_posting_location\": [\n \"<string>\"\n ],\n \"excluded_job_posting_location\": [\n \"<string>\"\n ],\n \"excluded_job_posting_functions\": [\n \"<string>\"\n ],\n \"job_posting_start_date\": \"<string>\",\n \"job_posting_end_date\": \"<string>\",\n \"job_posting_type\": [],\n \"job_posting_seniority\": [],\n \"experimental_industries\": [\n \"<string>\"\n ],\n \"excluded_experimental_industries\": [\n \"<string>\"\n ],\n \"experimental_member_department\": [\n \"<string>\"\n ],\n \"excluded_experimental_department\": [\n \"<string>\"\n ]\n },\n \"limit\": 2,\n \"webhook_url\": \"https://my-app.example.com/webhooks/sendpilot\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"created_at": "<string>",
"estimated_quota": 123
}Lead Database
Start Lead Database Search
Start a paid background search and retain its job ID for polling.
POST
/
v1
/
lead-database
/
searches
Create a lead database search
curl --request POST \
--url https://api.sendpilot.ai/v1/lead-database/searches \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"filters": {
"member_full_name": "<string>",
"job_titles": [
"<string>"
],
"excluded_job_titles": [
"<string>"
],
"member_skills": [
"<string>"
],
"excluded_member_skills": [
"<string>"
],
"member_linkedin_username": [
"<string>"
],
"excluded_member_linkedin_username": [
"<string>"
],
"locations": [
"<string>"
],
"excluded_locations": [
"<string>"
],
"member_description": [
"<string>"
],
"excluded_member_description": [
"<string>"
],
"seniority_levels": [],
"excluded_seniority_levels": [],
"member_department": [
"<string>"
],
"excluded_member_department": [
"<string>"
],
"member_certifications": [
"<string>"
],
"excluded_member_certifications": [
"<string>"
],
"min_total_experience_duration_months": 1,
"max_total_experience_duration_months": 1,
"min_job_duration_months": 1,
"max_job_duration_months": 1,
"companies": [
"<string>"
],
"excluded_companies": [
"<string>"
],
"bulk_domains": "<string>",
"excluded_bulk_domains": "<string>",
"company_linkedin_username": [
"<string>"
],
"excluded_company_linkedin_username": [
"<string>"
],
"company_type": [],
"excluded_company_type": [],
"industries": [
"<string>"
],
"excluded_industries": [
"<string>"
],
"is_mapped_industries_strict": true,
"company_sizes": [],
"excluded_company_sizes": [],
"hq_location": [
"<string>"
],
"excluded_hq_location": [
"<string>"
],
"sic_codes": [
{
"label": "<string>",
"value": "<string>"
}
],
"excluded_sic_codes": [
"<string>"
],
"naics_codes": [
{
"label": "<string>",
"value": "<string>"
}
],
"excluded_naics_codes": [
"<string>"
],
"keywords": [
"<string>"
],
"excluded_keywords": [
"<string>"
],
"last_funding_round_name": [],
"ownership_status": [],
"min_last_funding_round_amount_raised": 1,
"max_last_funding_round_amount_raised": 1,
"ipo_start_date": "<string>",
"ipo_end_date": "<string>",
"acquired_start_date": "<string>",
"acquired_end_date": "<string>",
"min_revenue_annual": 1,
"max_revenue_annual": 1,
"min_total_website_visits_monthly": 1,
"max_total_website_visits_monthly": 1,
"min_rank_global": 1,
"max_rank_global": 1,
"min_rank_country": 1,
"max_rank_country": 1,
"min_rank_category": 1,
"max_rank_category": 1,
"min_bounce_rate": 50,
"max_bounce_rate": 50,
"min_pages_per_visit": 1,
"max_pages_per_visit": 1,
"min_average_visit_duration_seconds": 1,
"max_average_visit_duration_seconds": 1,
"top_topics": [
"<string>"
],
"excluded_top_topics": [
"<string>"
],
"technologies_used": [
"<string>"
],
"excluded_technologies_used": [
"<string>"
],
"pricing_available": true,
"demo_available": true,
"documentation_exist": true,
"free_trial_available": true,
"is_downloadable": true,
"mobile_apps_exist": true,
"online_reviews_exist": true,
"min_company_employee_reviews_aggregate_score": 1,
"max_company_employee_reviews_aggregate_score": 1,
"job_posting_title": [
"<string>"
],
"excluded_job_posting_title": [
"<string>"
],
"job_posting_location": [
"<string>"
],
"excluded_job_posting_location": [
"<string>"
],
"excluded_job_posting_functions": [
"<string>"
],
"job_posting_start_date": "<string>",
"job_posting_end_date": "<string>",
"job_posting_type": [],
"job_posting_seniority": [],
"experimental_industries": [
"<string>"
],
"excluded_experimental_industries": [
"<string>"
],
"experimental_member_department": [
"<string>"
],
"excluded_experimental_department": [
"<string>"
]
},
"limit": 2,
"webhook_url": "https://my-app.example.com/webhooks/sendpilot"
}
'import requests
url = "https://api.sendpilot.ai/v1/lead-database/searches"
payload = {
"name": "<string>",
"filters": {
"member_full_name": "<string>",
"job_titles": ["<string>"],
"excluded_job_titles": ["<string>"],
"member_skills": ["<string>"],
"excluded_member_skills": ["<string>"],
"member_linkedin_username": ["<string>"],
"excluded_member_linkedin_username": ["<string>"],
"locations": ["<string>"],
"excluded_locations": ["<string>"],
"member_description": ["<string>"],
"excluded_member_description": ["<string>"],
"seniority_levels": [],
"excluded_seniority_levels": [],
"member_department": ["<string>"],
"excluded_member_department": ["<string>"],
"member_certifications": ["<string>"],
"excluded_member_certifications": ["<string>"],
"min_total_experience_duration_months": 1,
"max_total_experience_duration_months": 1,
"min_job_duration_months": 1,
"max_job_duration_months": 1,
"companies": ["<string>"],
"excluded_companies": ["<string>"],
"bulk_domains": "<string>",
"excluded_bulk_domains": "<string>",
"company_linkedin_username": ["<string>"],
"excluded_company_linkedin_username": ["<string>"],
"company_type": [],
"excluded_company_type": [],
"industries": ["<string>"],
"excluded_industries": ["<string>"],
"is_mapped_industries_strict": True,
"company_sizes": [],
"excluded_company_sizes": [],
"hq_location": ["<string>"],
"excluded_hq_location": ["<string>"],
"sic_codes": [
{
"label": "<string>",
"value": "<string>"
}
],
"excluded_sic_codes": ["<string>"],
"naics_codes": [
{
"label": "<string>",
"value": "<string>"
}
],
"excluded_naics_codes": ["<string>"],
"keywords": ["<string>"],
"excluded_keywords": ["<string>"],
"last_funding_round_name": [],
"ownership_status": [],
"min_last_funding_round_amount_raised": 1,
"max_last_funding_round_amount_raised": 1,
"ipo_start_date": "<string>",
"ipo_end_date": "<string>",
"acquired_start_date": "<string>",
"acquired_end_date": "<string>",
"min_revenue_annual": 1,
"max_revenue_annual": 1,
"min_total_website_visits_monthly": 1,
"max_total_website_visits_monthly": 1,
"min_rank_global": 1,
"max_rank_global": 1,
"min_rank_country": 1,
"max_rank_country": 1,
"min_rank_category": 1,
"max_rank_category": 1,
"min_bounce_rate": 50,
"max_bounce_rate": 50,
"min_pages_per_visit": 1,
"max_pages_per_visit": 1,
"min_average_visit_duration_seconds": 1,
"max_average_visit_duration_seconds": 1,
"top_topics": ["<string>"],
"excluded_top_topics": ["<string>"],
"technologies_used": ["<string>"],
"excluded_technologies_used": ["<string>"],
"pricing_available": True,
"demo_available": True,
"documentation_exist": True,
"free_trial_available": True,
"is_downloadable": True,
"mobile_apps_exist": True,
"online_reviews_exist": True,
"min_company_employee_reviews_aggregate_score": 1,
"max_company_employee_reviews_aggregate_score": 1,
"job_posting_title": ["<string>"],
"excluded_job_posting_title": ["<string>"],
"job_posting_location": ["<string>"],
"excluded_job_posting_location": ["<string>"],
"excluded_job_posting_functions": ["<string>"],
"job_posting_start_date": "<string>",
"job_posting_end_date": "<string>",
"job_posting_type": [],
"job_posting_seniority": [],
"experimental_industries": ["<string>"],
"excluded_experimental_industries": ["<string>"],
"experimental_member_department": ["<string>"],
"excluded_experimental_department": ["<string>"]
},
"limit": 2,
"webhook_url": "https://my-app.example.com/webhooks/sendpilot"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
filters: {
member_full_name: '<string>',
job_titles: ['<string>'],
excluded_job_titles: ['<string>'],
member_skills: ['<string>'],
excluded_member_skills: ['<string>'],
member_linkedin_username: ['<string>'],
excluded_member_linkedin_username: ['<string>'],
locations: ['<string>'],
excluded_locations: ['<string>'],
member_description: ['<string>'],
excluded_member_description: ['<string>'],
seniority_levels: [],
excluded_seniority_levels: [],
member_department: ['<string>'],
excluded_member_department: ['<string>'],
member_certifications: ['<string>'],
excluded_member_certifications: ['<string>'],
min_total_experience_duration_months: 1,
max_total_experience_duration_months: 1,
min_job_duration_months: 1,
max_job_duration_months: 1,
companies: ['<string>'],
excluded_companies: ['<string>'],
bulk_domains: '<string>',
excluded_bulk_domains: '<string>',
company_linkedin_username: ['<string>'],
excluded_company_linkedin_username: ['<string>'],
company_type: [],
excluded_company_type: [],
industries: ['<string>'],
excluded_industries: ['<string>'],
is_mapped_industries_strict: true,
company_sizes: [],
excluded_company_sizes: [],
hq_location: ['<string>'],
excluded_hq_location: ['<string>'],
sic_codes: [{label: '<string>', value: '<string>'}],
excluded_sic_codes: ['<string>'],
naics_codes: [{label: '<string>', value: '<string>'}],
excluded_naics_codes: ['<string>'],
keywords: ['<string>'],
excluded_keywords: ['<string>'],
last_funding_round_name: [],
ownership_status: [],
min_last_funding_round_amount_raised: 1,
max_last_funding_round_amount_raised: 1,
ipo_start_date: '<string>',
ipo_end_date: '<string>',
acquired_start_date: '<string>',
acquired_end_date: '<string>',
min_revenue_annual: 1,
max_revenue_annual: 1,
min_total_website_visits_monthly: 1,
max_total_website_visits_monthly: 1,
min_rank_global: 1,
max_rank_global: 1,
min_rank_country: 1,
max_rank_country: 1,
min_rank_category: 1,
max_rank_category: 1,
min_bounce_rate: 50,
max_bounce_rate: 50,
min_pages_per_visit: 1,
max_pages_per_visit: 1,
min_average_visit_duration_seconds: 1,
max_average_visit_duration_seconds: 1,
top_topics: ['<string>'],
excluded_top_topics: ['<string>'],
technologies_used: ['<string>'],
excluded_technologies_used: ['<string>'],
pricing_available: true,
demo_available: true,
documentation_exist: true,
free_trial_available: true,
is_downloadable: true,
mobile_apps_exist: true,
online_reviews_exist: true,
min_company_employee_reviews_aggregate_score: 1,
max_company_employee_reviews_aggregate_score: 1,
job_posting_title: ['<string>'],
excluded_job_posting_title: ['<string>'],
job_posting_location: ['<string>'],
excluded_job_posting_location: ['<string>'],
excluded_job_posting_functions: ['<string>'],
job_posting_start_date: '<string>',
job_posting_end_date: '<string>',
job_posting_type: [],
job_posting_seniority: [],
experimental_industries: ['<string>'],
excluded_experimental_industries: ['<string>'],
experimental_member_department: ['<string>'],
excluded_experimental_department: ['<string>']
},
limit: 2,
webhook_url: 'https://my-app.example.com/webhooks/sendpilot'
})
};
fetch('https://api.sendpilot.ai/v1/lead-database/searches', 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-database/searches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'filters' => [
'member_full_name' => '<string>',
'job_titles' => [
'<string>'
],
'excluded_job_titles' => [
'<string>'
],
'member_skills' => [
'<string>'
],
'excluded_member_skills' => [
'<string>'
],
'member_linkedin_username' => [
'<string>'
],
'excluded_member_linkedin_username' => [
'<string>'
],
'locations' => [
'<string>'
],
'excluded_locations' => [
'<string>'
],
'member_description' => [
'<string>'
],
'excluded_member_description' => [
'<string>'
],
'seniority_levels' => [
],
'excluded_seniority_levels' => [
],
'member_department' => [
'<string>'
],
'excluded_member_department' => [
'<string>'
],
'member_certifications' => [
'<string>'
],
'excluded_member_certifications' => [
'<string>'
],
'min_total_experience_duration_months' => 1,
'max_total_experience_duration_months' => 1,
'min_job_duration_months' => 1,
'max_job_duration_months' => 1,
'companies' => [
'<string>'
],
'excluded_companies' => [
'<string>'
],
'bulk_domains' => '<string>',
'excluded_bulk_domains' => '<string>',
'company_linkedin_username' => [
'<string>'
],
'excluded_company_linkedin_username' => [
'<string>'
],
'company_type' => [
],
'excluded_company_type' => [
],
'industries' => [
'<string>'
],
'excluded_industries' => [
'<string>'
],
'is_mapped_industries_strict' => true,
'company_sizes' => [
],
'excluded_company_sizes' => [
],
'hq_location' => [
'<string>'
],
'excluded_hq_location' => [
'<string>'
],
'sic_codes' => [
[
'label' => '<string>',
'value' => '<string>'
]
],
'excluded_sic_codes' => [
'<string>'
],
'naics_codes' => [
[
'label' => '<string>',
'value' => '<string>'
]
],
'excluded_naics_codes' => [
'<string>'
],
'keywords' => [
'<string>'
],
'excluded_keywords' => [
'<string>'
],
'last_funding_round_name' => [
],
'ownership_status' => [
],
'min_last_funding_round_amount_raised' => 1,
'max_last_funding_round_amount_raised' => 1,
'ipo_start_date' => '<string>',
'ipo_end_date' => '<string>',
'acquired_start_date' => '<string>',
'acquired_end_date' => '<string>',
'min_revenue_annual' => 1,
'max_revenue_annual' => 1,
'min_total_website_visits_monthly' => 1,
'max_total_website_visits_monthly' => 1,
'min_rank_global' => 1,
'max_rank_global' => 1,
'min_rank_country' => 1,
'max_rank_country' => 1,
'min_rank_category' => 1,
'max_rank_category' => 1,
'min_bounce_rate' => 50,
'max_bounce_rate' => 50,
'min_pages_per_visit' => 1,
'max_pages_per_visit' => 1,
'min_average_visit_duration_seconds' => 1,
'max_average_visit_duration_seconds' => 1,
'top_topics' => [
'<string>'
],
'excluded_top_topics' => [
'<string>'
],
'technologies_used' => [
'<string>'
],
'excluded_technologies_used' => [
'<string>'
],
'pricing_available' => true,
'demo_available' => true,
'documentation_exist' => true,
'free_trial_available' => true,
'is_downloadable' => true,
'mobile_apps_exist' => true,
'online_reviews_exist' => true,
'min_company_employee_reviews_aggregate_score' => 1,
'max_company_employee_reviews_aggregate_score' => 1,
'job_posting_title' => [
'<string>'
],
'excluded_job_posting_title' => [
'<string>'
],
'job_posting_location' => [
'<string>'
],
'excluded_job_posting_location' => [
'<string>'
],
'excluded_job_posting_functions' => [
'<string>'
],
'job_posting_start_date' => '<string>',
'job_posting_end_date' => '<string>',
'job_posting_type' => [
],
'job_posting_seniority' => [
],
'experimental_industries' => [
'<string>'
],
'excluded_experimental_industries' => [
'<string>'
],
'experimental_member_department' => [
'<string>'
],
'excluded_experimental_department' => [
'<string>'
]
],
'limit' => 2,
'webhook_url' => 'https://my-app.example.com/webhooks/sendpilot'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sendpilot.ai/v1/lead-database/searches"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"filters\": {\n \"member_full_name\": \"<string>\",\n \"job_titles\": [\n \"<string>\"\n ],\n \"excluded_job_titles\": [\n \"<string>\"\n ],\n \"member_skills\": [\n \"<string>\"\n ],\n \"excluded_member_skills\": [\n \"<string>\"\n ],\n \"member_linkedin_username\": [\n \"<string>\"\n ],\n \"excluded_member_linkedin_username\": [\n \"<string>\"\n ],\n \"locations\": [\n \"<string>\"\n ],\n \"excluded_locations\": [\n \"<string>\"\n ],\n \"member_description\": [\n \"<string>\"\n ],\n \"excluded_member_description\": [\n \"<string>\"\n ],\n \"seniority_levels\": [],\n \"excluded_seniority_levels\": [],\n \"member_department\": [\n \"<string>\"\n ],\n \"excluded_member_department\": [\n \"<string>\"\n ],\n \"member_certifications\": [\n \"<string>\"\n ],\n \"excluded_member_certifications\": [\n \"<string>\"\n ],\n \"min_total_experience_duration_months\": 1,\n \"max_total_experience_duration_months\": 1,\n \"min_job_duration_months\": 1,\n \"max_job_duration_months\": 1,\n \"companies\": [\n \"<string>\"\n ],\n \"excluded_companies\": [\n \"<string>\"\n ],\n \"bulk_domains\": \"<string>\",\n \"excluded_bulk_domains\": \"<string>\",\n \"company_linkedin_username\": [\n \"<string>\"\n ],\n \"excluded_company_linkedin_username\": [\n \"<string>\"\n ],\n \"company_type\": [],\n \"excluded_company_type\": [],\n \"industries\": [\n \"<string>\"\n ],\n \"excluded_industries\": [\n \"<string>\"\n ],\n \"is_mapped_industries_strict\": true,\n \"company_sizes\": [],\n \"excluded_company_sizes\": [],\n \"hq_location\": [\n \"<string>\"\n ],\n \"excluded_hq_location\": [\n \"<string>\"\n ],\n \"sic_codes\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"excluded_sic_codes\": [\n \"<string>\"\n ],\n \"naics_codes\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"excluded_naics_codes\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"<string>\"\n ],\n \"excluded_keywords\": [\n \"<string>\"\n ],\n \"last_funding_round_name\": [],\n \"ownership_status\": [],\n \"min_last_funding_round_amount_raised\": 1,\n \"max_last_funding_round_amount_raised\": 1,\n \"ipo_start_date\": \"<string>\",\n \"ipo_end_date\": \"<string>\",\n \"acquired_start_date\": \"<string>\",\n \"acquired_end_date\": \"<string>\",\n \"min_revenue_annual\": 1,\n \"max_revenue_annual\": 1,\n \"min_total_website_visits_monthly\": 1,\n \"max_total_website_visits_monthly\": 1,\n \"min_rank_global\": 1,\n \"max_rank_global\": 1,\n \"min_rank_country\": 1,\n \"max_rank_country\": 1,\n \"min_rank_category\": 1,\n \"max_rank_category\": 1,\n \"min_bounce_rate\": 50,\n \"max_bounce_rate\": 50,\n \"min_pages_per_visit\": 1,\n \"max_pages_per_visit\": 1,\n \"min_average_visit_duration_seconds\": 1,\n \"max_average_visit_duration_seconds\": 1,\n \"top_topics\": [\n \"<string>\"\n ],\n \"excluded_top_topics\": [\n \"<string>\"\n ],\n \"technologies_used\": [\n \"<string>\"\n ],\n \"excluded_technologies_used\": [\n \"<string>\"\n ],\n \"pricing_available\": true,\n \"demo_available\": true,\n \"documentation_exist\": true,\n \"free_trial_available\": true,\n \"is_downloadable\": true,\n \"mobile_apps_exist\": true,\n \"online_reviews_exist\": true,\n \"min_company_employee_reviews_aggregate_score\": 1,\n \"max_company_employee_reviews_aggregate_score\": 1,\n \"job_posting_title\": [\n \"<string>\"\n ],\n \"excluded_job_posting_title\": [\n \"<string>\"\n ],\n \"job_posting_location\": [\n \"<string>\"\n ],\n \"excluded_job_posting_location\": [\n \"<string>\"\n ],\n \"excluded_job_posting_functions\": [\n \"<string>\"\n ],\n \"job_posting_start_date\": \"<string>\",\n \"job_posting_end_date\": \"<string>\",\n \"job_posting_type\": [],\n \"job_posting_seniority\": [],\n \"experimental_industries\": [\n \"<string>\"\n ],\n \"excluded_experimental_industries\": [\n \"<string>\"\n ],\n \"experimental_member_department\": [\n \"<string>\"\n ],\n \"excluded_experimental_department\": [\n \"<string>\"\n ]\n },\n \"limit\": 2,\n \"webhook_url\": \"https://my-app.example.com/webhooks/sendpilot\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sendpilot.ai/v1/lead-database/searches")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"filters\": {\n \"member_full_name\": \"<string>\",\n \"job_titles\": [\n \"<string>\"\n ],\n \"excluded_job_titles\": [\n \"<string>\"\n ],\n \"member_skills\": [\n \"<string>\"\n ],\n \"excluded_member_skills\": [\n \"<string>\"\n ],\n \"member_linkedin_username\": [\n \"<string>\"\n ],\n \"excluded_member_linkedin_username\": [\n \"<string>\"\n ],\n \"locations\": [\n \"<string>\"\n ],\n \"excluded_locations\": [\n \"<string>\"\n ],\n \"member_description\": [\n \"<string>\"\n ],\n \"excluded_member_description\": [\n \"<string>\"\n ],\n \"seniority_levels\": [],\n \"excluded_seniority_levels\": [],\n \"member_department\": [\n \"<string>\"\n ],\n \"excluded_member_department\": [\n \"<string>\"\n ],\n \"member_certifications\": [\n \"<string>\"\n ],\n \"excluded_member_certifications\": [\n \"<string>\"\n ],\n \"min_total_experience_duration_months\": 1,\n \"max_total_experience_duration_months\": 1,\n \"min_job_duration_months\": 1,\n \"max_job_duration_months\": 1,\n \"companies\": [\n \"<string>\"\n ],\n \"excluded_companies\": [\n \"<string>\"\n ],\n \"bulk_domains\": \"<string>\",\n \"excluded_bulk_domains\": \"<string>\",\n \"company_linkedin_username\": [\n \"<string>\"\n ],\n \"excluded_company_linkedin_username\": [\n \"<string>\"\n ],\n \"company_type\": [],\n \"excluded_company_type\": [],\n \"industries\": [\n \"<string>\"\n ],\n \"excluded_industries\": [\n \"<string>\"\n ],\n \"is_mapped_industries_strict\": true,\n \"company_sizes\": [],\n \"excluded_company_sizes\": [],\n \"hq_location\": [\n \"<string>\"\n ],\n \"excluded_hq_location\": [\n \"<string>\"\n ],\n \"sic_codes\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"excluded_sic_codes\": [\n \"<string>\"\n ],\n \"naics_codes\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"excluded_naics_codes\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"<string>\"\n ],\n \"excluded_keywords\": [\n \"<string>\"\n ],\n \"last_funding_round_name\": [],\n \"ownership_status\": [],\n \"min_last_funding_round_amount_raised\": 1,\n \"max_last_funding_round_amount_raised\": 1,\n \"ipo_start_date\": \"<string>\",\n \"ipo_end_date\": \"<string>\",\n \"acquired_start_date\": \"<string>\",\n \"acquired_end_date\": \"<string>\",\n \"min_revenue_annual\": 1,\n \"max_revenue_annual\": 1,\n \"min_total_website_visits_monthly\": 1,\n \"max_total_website_visits_monthly\": 1,\n \"min_rank_global\": 1,\n \"max_rank_global\": 1,\n \"min_rank_country\": 1,\n \"max_rank_country\": 1,\n \"min_rank_category\": 1,\n \"max_rank_category\": 1,\n \"min_bounce_rate\": 50,\n \"max_bounce_rate\": 50,\n \"min_pages_per_visit\": 1,\n \"max_pages_per_visit\": 1,\n \"min_average_visit_duration_seconds\": 1,\n \"max_average_visit_duration_seconds\": 1,\n \"top_topics\": [\n \"<string>\"\n ],\n \"excluded_top_topics\": [\n \"<string>\"\n ],\n \"technologies_used\": [\n \"<string>\"\n ],\n \"excluded_technologies_used\": [\n \"<string>\"\n ],\n \"pricing_available\": true,\n \"demo_available\": true,\n \"documentation_exist\": true,\n \"free_trial_available\": true,\n \"is_downloadable\": true,\n \"mobile_apps_exist\": true,\n \"online_reviews_exist\": true,\n \"min_company_employee_reviews_aggregate_score\": 1,\n \"max_company_employee_reviews_aggregate_score\": 1,\n \"job_posting_title\": [\n \"<string>\"\n ],\n \"excluded_job_posting_title\": [\n \"<string>\"\n ],\n \"job_posting_location\": [\n \"<string>\"\n ],\n \"excluded_job_posting_location\": [\n \"<string>\"\n ],\n \"excluded_job_posting_functions\": [\n \"<string>\"\n ],\n \"job_posting_start_date\": \"<string>\",\n \"job_posting_end_date\": \"<string>\",\n \"job_posting_type\": [],\n \"job_posting_seniority\": [],\n \"experimental_industries\": [\n \"<string>\"\n ],\n \"excluded_experimental_industries\": [\n \"<string>\"\n ],\n \"experimental_member_department\": [\n \"<string>\"\n ],\n \"excluded_experimental_department\": [\n \"<string>\"\n ]\n },\n \"limit\": 2,\n \"webhook_url\": \"https://my-app.example.com/webhooks/sendpilot\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sendpilot.ai/v1/lead-database/searches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"filters\": {\n \"member_full_name\": \"<string>\",\n \"job_titles\": [\n \"<string>\"\n ],\n \"excluded_job_titles\": [\n \"<string>\"\n ],\n \"member_skills\": [\n \"<string>\"\n ],\n \"excluded_member_skills\": [\n \"<string>\"\n ],\n \"member_linkedin_username\": [\n \"<string>\"\n ],\n \"excluded_member_linkedin_username\": [\n \"<string>\"\n ],\n \"locations\": [\n \"<string>\"\n ],\n \"excluded_locations\": [\n \"<string>\"\n ],\n \"member_description\": [\n \"<string>\"\n ],\n \"excluded_member_description\": [\n \"<string>\"\n ],\n \"seniority_levels\": [],\n \"excluded_seniority_levels\": [],\n \"member_department\": [\n \"<string>\"\n ],\n \"excluded_member_department\": [\n \"<string>\"\n ],\n \"member_certifications\": [\n \"<string>\"\n ],\n \"excluded_member_certifications\": [\n \"<string>\"\n ],\n \"min_total_experience_duration_months\": 1,\n \"max_total_experience_duration_months\": 1,\n \"min_job_duration_months\": 1,\n \"max_job_duration_months\": 1,\n \"companies\": [\n \"<string>\"\n ],\n \"excluded_companies\": [\n \"<string>\"\n ],\n \"bulk_domains\": \"<string>\",\n \"excluded_bulk_domains\": \"<string>\",\n \"company_linkedin_username\": [\n \"<string>\"\n ],\n \"excluded_company_linkedin_username\": [\n \"<string>\"\n ],\n \"company_type\": [],\n \"excluded_company_type\": [],\n \"industries\": [\n \"<string>\"\n ],\n \"excluded_industries\": [\n \"<string>\"\n ],\n \"is_mapped_industries_strict\": true,\n \"company_sizes\": [],\n \"excluded_company_sizes\": [],\n \"hq_location\": [\n \"<string>\"\n ],\n \"excluded_hq_location\": [\n \"<string>\"\n ],\n \"sic_codes\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"excluded_sic_codes\": [\n \"<string>\"\n ],\n \"naics_codes\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"excluded_naics_codes\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"<string>\"\n ],\n \"excluded_keywords\": [\n \"<string>\"\n ],\n \"last_funding_round_name\": [],\n \"ownership_status\": [],\n \"min_last_funding_round_amount_raised\": 1,\n \"max_last_funding_round_amount_raised\": 1,\n \"ipo_start_date\": \"<string>\",\n \"ipo_end_date\": \"<string>\",\n \"acquired_start_date\": \"<string>\",\n \"acquired_end_date\": \"<string>\",\n \"min_revenue_annual\": 1,\n \"max_revenue_annual\": 1,\n \"min_total_website_visits_monthly\": 1,\n \"max_total_website_visits_monthly\": 1,\n \"min_rank_global\": 1,\n \"max_rank_global\": 1,\n \"min_rank_country\": 1,\n \"max_rank_country\": 1,\n \"min_rank_category\": 1,\n \"max_rank_category\": 1,\n \"min_bounce_rate\": 50,\n \"max_bounce_rate\": 50,\n \"min_pages_per_visit\": 1,\n \"max_pages_per_visit\": 1,\n \"min_average_visit_duration_seconds\": 1,\n \"max_average_visit_duration_seconds\": 1,\n \"top_topics\": [\n \"<string>\"\n ],\n \"excluded_top_topics\": [\n \"<string>\"\n ],\n \"technologies_used\": [\n \"<string>\"\n ],\n \"excluded_technologies_used\": [\n \"<string>\"\n ],\n \"pricing_available\": true,\n \"demo_available\": true,\n \"documentation_exist\": true,\n \"free_trial_available\": true,\n \"is_downloadable\": true,\n \"mobile_apps_exist\": true,\n \"online_reviews_exist\": true,\n \"min_company_employee_reviews_aggregate_score\": 1,\n \"max_company_employee_reviews_aggregate_score\": 1,\n \"job_posting_title\": [\n \"<string>\"\n ],\n \"excluded_job_posting_title\": [\n \"<string>\"\n ],\n \"job_posting_location\": [\n \"<string>\"\n ],\n \"excluded_job_posting_location\": [\n \"<string>\"\n ],\n \"excluded_job_posting_functions\": [\n \"<string>\"\n ],\n \"job_posting_start_date\": \"<string>\",\n \"job_posting_end_date\": \"<string>\",\n \"job_posting_type\": [],\n \"job_posting_seniority\": [],\n \"experimental_industries\": [\n \"<string>\"\n ],\n \"excluded_experimental_industries\": [\n \"<string>\"\n ],\n \"experimental_member_department\": [\n \"<string>\"\n ],\n \"excluded_experimental_department\": [\n \"<string>\"\n ]\n },\n \"limit\": 2,\n \"webhook_url\": \"https://my-app.example.com/webhooks/sendpilot\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"created_at": "<string>",
"estimated_quota": 123
}Requires
lead_sourcing:run and the creator’s ALLOW_LEAD_FINDER workspace permission. Supply name, filters, and limit (at least 1). The generated filter schema defines supported job, person, company, technology and experience fields.
Use Discover Lead Filters for current schemas and values before creating a search. industries is mapped to experimental_industries at the provider boundary; exclusions and department aliases are preserved. SIC/NAICS code objects are converted to their code values for the provider. Removed/unknown filters and conflicting aliases fail validation rather than being silently discarded.
job_title_match_mode accepts exact, contains or smart; job_title_smart_mode is used with smart. is_mapped_industries_strict controls exact versus related industry matching. Date filters accept the documented dd/mm/yyyy form and existing ISO date input. Use integers for numeric criteria and at most 100 entries per array filter.
Matching controls alone do not restrict a search: include an actual criterion such as job titles, locations or industries. If a previous attempt failed definitively, its idempotency result can still be cached; treat a corrected attempt as a new operation only after checking the original outcome. Never use a new key to bypass an uncertain submission.
The search reserves 2 credits per requested lead; unused credits are returned on completion. REST has no fixed lead-count ceiling in this DTO beyond available credits; the MCP search tool separately limits requests to 1,000 leads.
The response’s id is the search job ID, not a campaign ID. Save it and poll status, then read results. Do not start another paid search merely because the first is still processing.
webhook_url is an optional public HTTPS completion destination. Use an Idempotency-Key for retryable creation.Authorizations
API key for authentication (prefix: sp_live_ or sp_test_)
Body
application/json
Search name
Show child attributes
Show child attributes
Maximum leads to find (no hard limit - capped by available credits)
Required range:
x >= 1HTTPS URL to receive a completion notification. Must be a public host.
Example:
"https://my-app.example.com/webhooks/sendpilot"