Preview leads from supersearch
curl --request POST \
--url https://api.instantly.ai/api/v2/supersearch-enrichment/preview-leads-from-supersearch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"search_filters": {
"locations": [
{
"place_id": "ChIJN1t_t3uEmsRUso9K6W47H4",
"label": "San Francisco, CA, USA"
}
],
"department": [
"Engineering"
],
"level": [
"Entry level"
],
"employeeCount": [
"0 - 25"
],
"revenue": [
"$1 - 10M"
],
"news": [
"launches"
],
"jobListing": [
"Software Engineer"
],
"jobListingFilter": [
"Software Engineer"
],
"title": {
"include": [
"CEO"
],
"exclude": [
"VP"
]
},
"name": [
"John Doe"
],
"company_name": {
"include": [
"Google"
],
"exclude": [
"Amazon"
]
},
"look_alike": "google.com",
"keyword_filter": {
"exclude": "sales",
"include": "marketing"
},
"industry": {
"exclude": [
"Agriculture & Mining"
],
"include": [
"Agriculture & Mining"
]
},
"subIndustry": {
"exclude": [
"Animation"
],
"include": [
"Animation"
]
},
"domains": [
"google.com"
],
"funding_type": [
"angel"
],
"signals": [
"job_change"
],
"skip_owned_leads": true,
"show_one_lead_per_company": true,
"location_mode": "contact"
}
}
'import requests
url = "https://api.instantly.ai/api/v2/supersearch-enrichment/preview-leads-from-supersearch"
payload = { "search_filters": {
"locations": [
{
"place_id": "ChIJN1t_t3uEmsRUso9K6W47H4",
"label": "San Francisco, CA, USA"
}
],
"department": ["Engineering"],
"level": ["Entry level"],
"employeeCount": ["0 - 25"],
"revenue": ["$1 - 10M"],
"news": ["launches"],
"jobListing": ["Software Engineer"],
"jobListingFilter": ["Software Engineer"],
"title": {
"include": ["CEO"],
"exclude": ["VP"]
},
"name": ["John Doe"],
"company_name": {
"include": ["Google"],
"exclude": ["Amazon"]
},
"look_alike": "google.com",
"keyword_filter": {
"exclude": "sales",
"include": "marketing"
},
"industry": {
"exclude": ["Agriculture & Mining"],
"include": ["Agriculture & Mining"]
},
"subIndustry": {
"exclude": ["Animation"],
"include": ["Animation"]
},
"domains": ["google.com"],
"funding_type": ["angel"],
"signals": ["job_change"],
"skip_owned_leads": True,
"show_one_lead_per_company": True,
"location_mode": "contact"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
search_filters: {
locations: [{place_id: 'ChIJN1t_t3uEmsRUso9K6W47H4', label: 'San Francisco, CA, USA'}],
department: ['Engineering'],
level: ['Entry level'],
employeeCount: ['0 - 25'],
revenue: ['$1 - 10M'],
news: ['launches'],
jobListing: ['Software Engineer'],
jobListingFilter: ['Software Engineer'],
title: {include: ['CEO'], exclude: ['VP']},
name: ['John Doe'],
company_name: {include: ['Google'], exclude: ['Amazon']},
look_alike: 'google.com',
keyword_filter: {exclude: 'sales', include: 'marketing'},
industry: {exclude: ['Agriculture & Mining'], include: ['Agriculture & Mining']},
subIndustry: {exclude: ['Animation'], include: ['Animation']},
domains: ['google.com'],
funding_type: ['angel'],
signals: ['job_change'],
skip_owned_leads: true,
show_one_lead_per_company: true,
location_mode: 'contact'
}
})
};
fetch('https://api.instantly.ai/api/v2/supersearch-enrichment/preview-leads-from-supersearch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.instantly.ai/api/v2/supersearch-enrichment/preview-leads-from-supersearch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"search_filters\": {\n \"locations\": [\n {\n \"place_id\": \"ChIJN1t_t3uEmsRUso9K6W47H4\",\n \"label\": \"San Francisco, CA, USA\"\n }\n ],\n \"department\": [\n \"Engineering\"\n ],\n \"level\": [\n \"Entry level\"\n ],\n \"employeeCount\": [\n \"0 - 25\"\n ],\n \"revenue\": [\n \"$1 - 10M\"\n ],\n \"news\": [\n \"launches\"\n ],\n \"jobListing\": [\n \"Software Engineer\"\n ],\n \"jobListingFilter\": [\n \"Software Engineer\"\n ],\n \"title\": {\n \"include\": [\n \"CEO\"\n ],\n \"exclude\": [\n \"VP\"\n ]\n },\n \"name\": [\n \"John Doe\"\n ],\n \"company_name\": {\n \"include\": [\n \"Google\"\n ],\n \"exclude\": [\n \"Amazon\"\n ]\n },\n \"look_alike\": \"google.com\",\n \"keyword_filter\": {\n \"exclude\": \"sales\",\n \"include\": \"marketing\"\n },\n \"industry\": {\n \"exclude\": [\n \"Agriculture & Mining\"\n ],\n \"include\": [\n \"Agriculture & Mining\"\n ]\n },\n \"subIndustry\": {\n \"exclude\": [\n \"Animation\"\n ],\n \"include\": [\n \"Animation\"\n ]\n },\n \"domains\": [\n \"google.com\"\n ],\n \"funding_type\": [\n \"angel\"\n ],\n \"signals\": [\n \"job_change\"\n ],\n \"skip_owned_leads\": true,\n \"show_one_lead_per_company\": true,\n \"location_mode\": \"contact\"\n }\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.instantly.ai/api/v2/supersearch-enrichment/preview-leads-from-supersearch",
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([
'search_filters' => [
'locations' => [
[
'place_id' => 'ChIJN1t_t3uEmsRUso9K6W47H4',
'label' => 'San Francisco, CA, USA'
]
],
'department' => [
'Engineering'
],
'level' => [
'Entry level'
],
'employeeCount' => [
'0 - 25'
],
'revenue' => [
'$1 - 10M'
],
'news' => [
'launches'
],
'jobListing' => [
'Software Engineer'
],
'jobListingFilter' => [
'Software Engineer'
],
'title' => [
'include' => [
'CEO'
],
'exclude' => [
'VP'
]
],
'name' => [
'John Doe'
],
'company_name' => [
'include' => [
'Google'
],
'exclude' => [
'Amazon'
]
],
'look_alike' => 'google.com',
'keyword_filter' => [
'exclude' => 'sales',
'include' => 'marketing'
],
'industry' => [
'exclude' => [
'Agriculture & Mining'
],
'include' => [
'Agriculture & Mining'
]
],
'subIndustry' => [
'exclude' => [
'Animation'
],
'include' => [
'Animation'
]
],
'domains' => [
'google.com'
],
'funding_type' => [
'angel'
],
'signals' => [
'job_change'
],
'skip_owned_leads' => true,
'show_one_lead_per_company' => true,
'location_mode' => 'contact'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.instantly.ai/api/v2/supersearch-enrichment/preview-leads-from-supersearch"
payload := strings.NewReader("{\n \"search_filters\": {\n \"locations\": [\n {\n \"place_id\": \"ChIJN1t_t3uEmsRUso9K6W47H4\",\n \"label\": \"San Francisco, CA, USA\"\n }\n ],\n \"department\": [\n \"Engineering\"\n ],\n \"level\": [\n \"Entry level\"\n ],\n \"employeeCount\": [\n \"0 - 25\"\n ],\n \"revenue\": [\n \"$1 - 10M\"\n ],\n \"news\": [\n \"launches\"\n ],\n \"jobListing\": [\n \"Software Engineer\"\n ],\n \"jobListingFilter\": [\n \"Software Engineer\"\n ],\n \"title\": {\n \"include\": [\n \"CEO\"\n ],\n \"exclude\": [\n \"VP\"\n ]\n },\n \"name\": [\n \"John Doe\"\n ],\n \"company_name\": {\n \"include\": [\n \"Google\"\n ],\n \"exclude\": [\n \"Amazon\"\n ]\n },\n \"look_alike\": \"google.com\",\n \"keyword_filter\": {\n \"exclude\": \"sales\",\n \"include\": \"marketing\"\n },\n \"industry\": {\n \"exclude\": [\n \"Agriculture & Mining\"\n ],\n \"include\": [\n \"Agriculture & Mining\"\n ]\n },\n \"subIndustry\": {\n \"exclude\": [\n \"Animation\"\n ],\n \"include\": [\n \"Animation\"\n ]\n },\n \"domains\": [\n \"google.com\"\n ],\n \"funding_type\": [\n \"angel\"\n ],\n \"signals\": [\n \"job_change\"\n ],\n \"skip_owned_leads\": true,\n \"show_one_lead_per_company\": true,\n \"location_mode\": \"contact\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}{
"number_of_leads": 100,
"number_of_redacted_results": 0,
"leads": [
{
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe",
"jobTitle": "Software Engineer",
"location": "San Francisco, California, United States",
"linkedIn": "linkedin.com/in/john-doe",
"companyName": "Acme Corp",
"companyLogo": "https://example.com/logo.png",
"companyId": "123456"
}
]
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Missing Authorization header"
}{
"statusCode": 402,
"error": "Rate limit exceeded",
"message": "Rate limit exceeded"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found"
}{
"statusCode": 429,
"error": "Rate limit exceeded",
"message": "Rate limit exceeded"
}SuperSearch Enrichment
Preview leads from supersearch
Preview the leads matching a SuperSearch query without enriching them
Requires one of the following scopes: supersearch_enrichments:read, supersearch_enrichments:all, all:read, all:all
POST
/
api
/
v2
/
supersearch-enrichment
/
preview-leads-from-supersearch
Preview leads from supersearch
curl --request POST \
--url https://api.instantly.ai/api/v2/supersearch-enrichment/preview-leads-from-supersearch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"search_filters": {
"locations": [
{
"place_id": "ChIJN1t_t3uEmsRUso9K6W47H4",
"label": "San Francisco, CA, USA"
}
],
"department": [
"Engineering"
],
"level": [
"Entry level"
],
"employeeCount": [
"0 - 25"
],
"revenue": [
"$1 - 10M"
],
"news": [
"launches"
],
"jobListing": [
"Software Engineer"
],
"jobListingFilter": [
"Software Engineer"
],
"title": {
"include": [
"CEO"
],
"exclude": [
"VP"
]
},
"name": [
"John Doe"
],
"company_name": {
"include": [
"Google"
],
"exclude": [
"Amazon"
]
},
"look_alike": "google.com",
"keyword_filter": {
"exclude": "sales",
"include": "marketing"
},
"industry": {
"exclude": [
"Agriculture & Mining"
],
"include": [
"Agriculture & Mining"
]
},
"subIndustry": {
"exclude": [
"Animation"
],
"include": [
"Animation"
]
},
"domains": [
"google.com"
],
"funding_type": [
"angel"
],
"signals": [
"job_change"
],
"skip_owned_leads": true,
"show_one_lead_per_company": true,
"location_mode": "contact"
}
}
'import requests
url = "https://api.instantly.ai/api/v2/supersearch-enrichment/preview-leads-from-supersearch"
payload = { "search_filters": {
"locations": [
{
"place_id": "ChIJN1t_t3uEmsRUso9K6W47H4",
"label": "San Francisco, CA, USA"
}
],
"department": ["Engineering"],
"level": ["Entry level"],
"employeeCount": ["0 - 25"],
"revenue": ["$1 - 10M"],
"news": ["launches"],
"jobListing": ["Software Engineer"],
"jobListingFilter": ["Software Engineer"],
"title": {
"include": ["CEO"],
"exclude": ["VP"]
},
"name": ["John Doe"],
"company_name": {
"include": ["Google"],
"exclude": ["Amazon"]
},
"look_alike": "google.com",
"keyword_filter": {
"exclude": "sales",
"include": "marketing"
},
"industry": {
"exclude": ["Agriculture & Mining"],
"include": ["Agriculture & Mining"]
},
"subIndustry": {
"exclude": ["Animation"],
"include": ["Animation"]
},
"domains": ["google.com"],
"funding_type": ["angel"],
"signals": ["job_change"],
"skip_owned_leads": True,
"show_one_lead_per_company": True,
"location_mode": "contact"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
search_filters: {
locations: [{place_id: 'ChIJN1t_t3uEmsRUso9K6W47H4', label: 'San Francisco, CA, USA'}],
department: ['Engineering'],
level: ['Entry level'],
employeeCount: ['0 - 25'],
revenue: ['$1 - 10M'],
news: ['launches'],
jobListing: ['Software Engineer'],
jobListingFilter: ['Software Engineer'],
title: {include: ['CEO'], exclude: ['VP']},
name: ['John Doe'],
company_name: {include: ['Google'], exclude: ['Amazon']},
look_alike: 'google.com',
keyword_filter: {exclude: 'sales', include: 'marketing'},
industry: {exclude: ['Agriculture & Mining'], include: ['Agriculture & Mining']},
subIndustry: {exclude: ['Animation'], include: ['Animation']},
domains: ['google.com'],
funding_type: ['angel'],
signals: ['job_change'],
skip_owned_leads: true,
show_one_lead_per_company: true,
location_mode: 'contact'
}
})
};
fetch('https://api.instantly.ai/api/v2/supersearch-enrichment/preview-leads-from-supersearch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.instantly.ai/api/v2/supersearch-enrichment/preview-leads-from-supersearch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"search_filters\": {\n \"locations\": [\n {\n \"place_id\": \"ChIJN1t_t3uEmsRUso9K6W47H4\",\n \"label\": \"San Francisco, CA, USA\"\n }\n ],\n \"department\": [\n \"Engineering\"\n ],\n \"level\": [\n \"Entry level\"\n ],\n \"employeeCount\": [\n \"0 - 25\"\n ],\n \"revenue\": [\n \"$1 - 10M\"\n ],\n \"news\": [\n \"launches\"\n ],\n \"jobListing\": [\n \"Software Engineer\"\n ],\n \"jobListingFilter\": [\n \"Software Engineer\"\n ],\n \"title\": {\n \"include\": [\n \"CEO\"\n ],\n \"exclude\": [\n \"VP\"\n ]\n },\n \"name\": [\n \"John Doe\"\n ],\n \"company_name\": {\n \"include\": [\n \"Google\"\n ],\n \"exclude\": [\n \"Amazon\"\n ]\n },\n \"look_alike\": \"google.com\",\n \"keyword_filter\": {\n \"exclude\": \"sales\",\n \"include\": \"marketing\"\n },\n \"industry\": {\n \"exclude\": [\n \"Agriculture & Mining\"\n ],\n \"include\": [\n \"Agriculture & Mining\"\n ]\n },\n \"subIndustry\": {\n \"exclude\": [\n \"Animation\"\n ],\n \"include\": [\n \"Animation\"\n ]\n },\n \"domains\": [\n \"google.com\"\n ],\n \"funding_type\": [\n \"angel\"\n ],\n \"signals\": [\n \"job_change\"\n ],\n \"skip_owned_leads\": true,\n \"show_one_lead_per_company\": true,\n \"location_mode\": \"contact\"\n }\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.instantly.ai/api/v2/supersearch-enrichment/preview-leads-from-supersearch",
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([
'search_filters' => [
'locations' => [
[
'place_id' => 'ChIJN1t_t3uEmsRUso9K6W47H4',
'label' => 'San Francisco, CA, USA'
]
],
'department' => [
'Engineering'
],
'level' => [
'Entry level'
],
'employeeCount' => [
'0 - 25'
],
'revenue' => [
'$1 - 10M'
],
'news' => [
'launches'
],
'jobListing' => [
'Software Engineer'
],
'jobListingFilter' => [
'Software Engineer'
],
'title' => [
'include' => [
'CEO'
],
'exclude' => [
'VP'
]
],
'name' => [
'John Doe'
],
'company_name' => [
'include' => [
'Google'
],
'exclude' => [
'Amazon'
]
],
'look_alike' => 'google.com',
'keyword_filter' => [
'exclude' => 'sales',
'include' => 'marketing'
],
'industry' => [
'exclude' => [
'Agriculture & Mining'
],
'include' => [
'Agriculture & Mining'
]
],
'subIndustry' => [
'exclude' => [
'Animation'
],
'include' => [
'Animation'
]
],
'domains' => [
'google.com'
],
'funding_type' => [
'angel'
],
'signals' => [
'job_change'
],
'skip_owned_leads' => true,
'show_one_lead_per_company' => true,
'location_mode' => 'contact'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.instantly.ai/api/v2/supersearch-enrichment/preview-leads-from-supersearch"
payload := strings.NewReader("{\n \"search_filters\": {\n \"locations\": [\n {\n \"place_id\": \"ChIJN1t_t3uEmsRUso9K6W47H4\",\n \"label\": \"San Francisco, CA, USA\"\n }\n ],\n \"department\": [\n \"Engineering\"\n ],\n \"level\": [\n \"Entry level\"\n ],\n \"employeeCount\": [\n \"0 - 25\"\n ],\n \"revenue\": [\n \"$1 - 10M\"\n ],\n \"news\": [\n \"launches\"\n ],\n \"jobListing\": [\n \"Software Engineer\"\n ],\n \"jobListingFilter\": [\n \"Software Engineer\"\n ],\n \"title\": {\n \"include\": [\n \"CEO\"\n ],\n \"exclude\": [\n \"VP\"\n ]\n },\n \"name\": [\n \"John Doe\"\n ],\n \"company_name\": {\n \"include\": [\n \"Google\"\n ],\n \"exclude\": [\n \"Amazon\"\n ]\n },\n \"look_alike\": \"google.com\",\n \"keyword_filter\": {\n \"exclude\": \"sales\",\n \"include\": \"marketing\"\n },\n \"industry\": {\n \"exclude\": [\n \"Agriculture & Mining\"\n ],\n \"include\": [\n \"Agriculture & Mining\"\n ]\n },\n \"subIndustry\": {\n \"exclude\": [\n \"Animation\"\n ],\n \"include\": [\n \"Animation\"\n ]\n },\n \"domains\": [\n \"google.com\"\n ],\n \"funding_type\": [\n \"angel\"\n ],\n \"signals\": [\n \"job_change\"\n ],\n \"skip_owned_leads\": true,\n \"show_one_lead_per_company\": true,\n \"location_mode\": \"contact\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}{
"number_of_leads": 100,
"number_of_redacted_results": 0,
"leads": [
{
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe",
"jobTitle": "Software Engineer",
"location": "San Francisco, California, United States",
"linkedIn": "linkedin.com/in/john-doe",
"companyName": "Acme Corp",
"companyLogo": "https://example.com/logo.png",
"companyId": "123456"
}
]
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Missing Authorization header"
}{
"statusCode": 402,
"error": "Rate limit exceeded",
"message": "Rate limit exceeded"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found"
}{
"statusCode": 429,
"error": "Rate limit exceeded",
"message": "Rate limit exceeded"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Default Response
Number of leads found for this specific search. A value of 0 indicates that no leads match the criteria. Values greater than 1,000,000 are returned as 1,000,000.
Example:
100
Number of results that were redacted/hidden (for trial users).
Example:
0
The leads matching the search criteria
Show child attributes
Show child attributes
⌘I