Import Prospects
curl --request POST \
--url https://api.goextrovert.com/client/v2/lead-finder/imports \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"schemaVersion": "people.v1",
"destination": {
"listId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"moveOwnDuplicated": true,
"onlyRecentlyActive": true,
"listName": null
},
"idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"maxCreditsSpend": 50,
"query": {
"filters": [
{
"field": "contact.titleLatest",
"op": "any.include",
"mode": "SMART",
"values": [
"head of sales",
"sales director"
]
},
{
"field": "contact.seniority",
"op": "any.include",
"values": [
"director",
"head",
"vp"
]
},
{
"field": "contact.location",
"op": "any.include",
"values": [
"Germany"
]
},
{
"field": "account.industries",
"op": "any.include",
"mode": "SMART",
"values": [
"software development"
]
},
{
"field": "account.employeeSize",
"op": "range",
"ranges": [
{
"start": 51,
"end": 500
}
]
}
]
},
"count": 50,
"providerIds": [
"<string>"
]
}
'import requests
url = "https://api.goextrovert.com/client/v2/lead-finder/imports"
payload = {
"schemaVersion": "people.v1",
"destination": {
"listId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"moveOwnDuplicated": True,
"onlyRecentlyActive": True,
"listName": None
},
"idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"maxCreditsSpend": 50,
"query": { "filters": [
{
"field": "contact.titleLatest",
"op": "any.include",
"mode": "SMART",
"values": ["head of sales", "sales director"]
},
{
"field": "contact.seniority",
"op": "any.include",
"values": ["director", "head", "vp"]
},
{
"field": "contact.location",
"op": "any.include",
"values": ["Germany"]
},
{
"field": "account.industries",
"op": "any.include",
"mode": "SMART",
"values": ["software development"]
},
{
"field": "account.employeeSize",
"op": "range",
"ranges": [
{
"start": 51,
"end": 500
}
]
}
] },
"count": 50,
"providerIds": ["<string>"]
}
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({
schemaVersion: 'people.v1',
destination: {
listId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
campaignId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
moveOwnDuplicated: true,
onlyRecentlyActive: true,
listName: null
},
idempotencyKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
maxCreditsSpend: 50,
query: {
filters: [
{
field: 'contact.titleLatest',
op: 'any.include',
mode: 'SMART',
values: ['head of sales', 'sales director']
},
{
field: 'contact.seniority',
op: 'any.include',
values: ['director', 'head', 'vp']
},
{field: 'contact.location', op: 'any.include', values: ['Germany']},
{
field: 'account.industries',
op: 'any.include',
mode: 'SMART',
values: ['software development']
},
{field: 'account.employeeSize', op: 'range', ranges: [{start: 51, end: 500}]}
]
},
count: 50,
providerIds: ['<string>']
})
};
fetch('https://api.goextrovert.com/client/v2/lead-finder/imports', 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.goextrovert.com/client/v2/lead-finder/imports",
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([
'schemaVersion' => 'people.v1',
'destination' => [
'listId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'campaignId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'moveOwnDuplicated' => true,
'onlyRecentlyActive' => true,
'listName' => null
],
'idempotencyKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'maxCreditsSpend' => 50,
'query' => [
'filters' => [
[
'field' => 'contact.titleLatest',
'op' => 'any.include',
'mode' => 'SMART',
'values' => [
'head of sales',
'sales director'
]
],
[
'field' => 'contact.seniority',
'op' => 'any.include',
'values' => [
'director',
'head',
'vp'
]
],
[
'field' => 'contact.location',
'op' => 'any.include',
'values' => [
'Germany'
]
],
[
'field' => 'account.industries',
'op' => 'any.include',
'mode' => 'SMART',
'values' => [
'software development'
]
],
[
'field' => 'account.employeeSize',
'op' => 'range',
'ranges' => [
[
'start' => 51,
'end' => 500
]
]
]
]
],
'count' => 50,
'providerIds' => [
'<string>'
]
]),
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.goextrovert.com/client/v2/lead-finder/imports"
payload := strings.NewReader("{\n \"schemaVersion\": \"people.v1\",\n \"destination\": {\n \"listId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"moveOwnDuplicated\": true,\n \"onlyRecentlyActive\": true,\n \"listName\": null\n },\n \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"maxCreditsSpend\": 50,\n \"query\": {\n \"filters\": [\n {\n \"field\": \"contact.titleLatest\",\n \"op\": \"any.include\",\n \"mode\": \"SMART\",\n \"values\": [\n \"head of sales\",\n \"sales director\"\n ]\n },\n {\n \"field\": \"contact.seniority\",\n \"op\": \"any.include\",\n \"values\": [\n \"director\",\n \"head\",\n \"vp\"\n ]\n },\n {\n \"field\": \"contact.location\",\n \"op\": \"any.include\",\n \"values\": [\n \"Germany\"\n ]\n },\n {\n \"field\": \"account.industries\",\n \"op\": \"any.include\",\n \"mode\": \"SMART\",\n \"values\": [\n \"software development\"\n ]\n },\n {\n \"field\": \"account.employeeSize\",\n \"op\": \"range\",\n \"ranges\": [\n {\n \"start\": 51,\n \"end\": 500\n }\n ]\n }\n ]\n },\n \"count\": 50,\n \"providerIds\": [\n \"<string>\"\n ]\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.goextrovert.com/client/v2/lead-finder/imports")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"schemaVersion\": \"people.v1\",\n \"destination\": {\n \"listId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"moveOwnDuplicated\": true,\n \"onlyRecentlyActive\": true,\n \"listName\": null\n },\n \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"maxCreditsSpend\": 50,\n \"query\": {\n \"filters\": [\n {\n \"field\": \"contact.titleLatest\",\n \"op\": \"any.include\",\n \"mode\": \"SMART\",\n \"values\": [\n \"head of sales\",\n \"sales director\"\n ]\n },\n {\n \"field\": \"contact.seniority\",\n \"op\": \"any.include\",\n \"values\": [\n \"director\",\n \"head\",\n \"vp\"\n ]\n },\n {\n \"field\": \"contact.location\",\n \"op\": \"any.include\",\n \"values\": [\n \"Germany\"\n ]\n },\n {\n \"field\": \"account.industries\",\n \"op\": \"any.include\",\n \"mode\": \"SMART\",\n \"values\": [\n \"software development\"\n ]\n },\n {\n \"field\": \"account.employeeSize\",\n \"op\": \"range\",\n \"ranges\": [\n {\n \"start\": 51,\n \"end\": 500\n }\n ]\n }\n ]\n },\n \"count\": 50,\n \"providerIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goextrovert.com/client/v2/lead-finder/imports")
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 \"schemaVersion\": \"people.v1\",\n \"destination\": {\n \"listId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"moveOwnDuplicated\": true,\n \"onlyRecentlyActive\": true,\n \"listName\": null\n },\n \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"maxCreditsSpend\": 50,\n \"query\": {\n \"filters\": [\n {\n \"field\": \"contact.titleLatest\",\n \"op\": \"any.include\",\n \"mode\": \"SMART\",\n \"values\": [\n \"head of sales\",\n \"sales director\"\n ]\n },\n {\n \"field\": \"contact.seniority\",\n \"op\": \"any.include\",\n \"values\": [\n \"director\",\n \"head\",\n \"vp\"\n ]\n },\n {\n \"field\": \"contact.location\",\n \"op\": \"any.include\",\n \"values\": [\n \"Germany\"\n ]\n },\n {\n \"field\": \"account.industries\",\n \"op\": \"any.include\",\n \"mode\": \"SMART\",\n \"values\": [\n \"software development\"\n ]\n },\n {\n \"field\": \"account.employeeSize\",\n \"op\": \"range\",\n \"ranges\": [\n {\n \"start\": 51,\n \"end\": 500\n }\n ]\n }\n ]\n },\n \"count\": 50,\n \"providerIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"importId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"listId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replayed": true
},
"message": "Operation completed successfully"
}{
"status": "error",
"data": null,
"message": "An error occurred while processing the request"
}{
"status": "error",
"data": null,
"message": "An error occurred while processing the request"
}{
"status": "error",
"data": null,
"message": "An error occurred while processing the request"
}{
"status": "error",
"data": null,
"message": "An error occurred while processing the request"
}{
"status": "error",
"data": null,
"message": "An error occurred while processing the request"
}Lead Finder
Import Prospects
Starts a paid import of prospects into a prospect list of a campaign. The charge is per prospect retrieved, not per prospect added: each retrieved prospect costs 1 credit, including prospects that end up not added (already in prospects, invalid, or over Prospect Capacity). The response comes as soon as the import is accepted, with three ids: the import, the campaign and the list (the new list when listName was given).
The start is refused, and nothing is created or charged:
400: The request is refused: its query as the preview refuses it (named by its path such asquery.filters[0].valuesand, where known, its field and op), a campaign that is not a Prospects campaign (TARGET_USER), a list of another campaign, a count above the Prospect Capacity left or the search schema’slimits.resultCeiling, a balance that does not cover the cost, or a cost that could exceedmaxCreditsSpend.403: The caller cannot update the campaign, the plan is inactive or cannot spend credits, or theidempotencyKeybelongs to another workspace, user or API key.404: The campaign or the list does not exist.409: Another import of the campaign owner is still running; wait until it ends, then start again.
One idempotencyKey names one purchase: a retry with the same key returns the original purchase with replayed: true; its campaignId and listId may differ from this request; nothing new is started or charged. After a timeout, a network error, a 5xx or a 408, retry with the same key, since the purchase may already exist under it; after a 429, wait for Retry-After and retry with the same key. A 403 saying the idempotencyKey belongs to another workspace, user or API key means the key already names a purchase made by another caller: it is not proof that nothing was bought, so retry only with the same API key or user that made it. Any other 4xx means no purchase was created, and a new purchase takes a new key. The result — prospects added and credits charged — is not part of this response; it can be read by the import id once the import ends.
POST
/
client
/
v2
/
lead-finder
/
imports
Import Prospects
curl --request POST \
--url https://api.goextrovert.com/client/v2/lead-finder/imports \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"schemaVersion": "people.v1",
"destination": {
"listId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"moveOwnDuplicated": true,
"onlyRecentlyActive": true,
"listName": null
},
"idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"maxCreditsSpend": 50,
"query": {
"filters": [
{
"field": "contact.titleLatest",
"op": "any.include",
"mode": "SMART",
"values": [
"head of sales",
"sales director"
]
},
{
"field": "contact.seniority",
"op": "any.include",
"values": [
"director",
"head",
"vp"
]
},
{
"field": "contact.location",
"op": "any.include",
"values": [
"Germany"
]
},
{
"field": "account.industries",
"op": "any.include",
"mode": "SMART",
"values": [
"software development"
]
},
{
"field": "account.employeeSize",
"op": "range",
"ranges": [
{
"start": 51,
"end": 500
}
]
}
]
},
"count": 50,
"providerIds": [
"<string>"
]
}
'import requests
url = "https://api.goextrovert.com/client/v2/lead-finder/imports"
payload = {
"schemaVersion": "people.v1",
"destination": {
"listId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"moveOwnDuplicated": True,
"onlyRecentlyActive": True,
"listName": None
},
"idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"maxCreditsSpend": 50,
"query": { "filters": [
{
"field": "contact.titleLatest",
"op": "any.include",
"mode": "SMART",
"values": ["head of sales", "sales director"]
},
{
"field": "contact.seniority",
"op": "any.include",
"values": ["director", "head", "vp"]
},
{
"field": "contact.location",
"op": "any.include",
"values": ["Germany"]
},
{
"field": "account.industries",
"op": "any.include",
"mode": "SMART",
"values": ["software development"]
},
{
"field": "account.employeeSize",
"op": "range",
"ranges": [
{
"start": 51,
"end": 500
}
]
}
] },
"count": 50,
"providerIds": ["<string>"]
}
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({
schemaVersion: 'people.v1',
destination: {
listId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
campaignId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
moveOwnDuplicated: true,
onlyRecentlyActive: true,
listName: null
},
idempotencyKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
maxCreditsSpend: 50,
query: {
filters: [
{
field: 'contact.titleLatest',
op: 'any.include',
mode: 'SMART',
values: ['head of sales', 'sales director']
},
{
field: 'contact.seniority',
op: 'any.include',
values: ['director', 'head', 'vp']
},
{field: 'contact.location', op: 'any.include', values: ['Germany']},
{
field: 'account.industries',
op: 'any.include',
mode: 'SMART',
values: ['software development']
},
{field: 'account.employeeSize', op: 'range', ranges: [{start: 51, end: 500}]}
]
},
count: 50,
providerIds: ['<string>']
})
};
fetch('https://api.goextrovert.com/client/v2/lead-finder/imports', 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.goextrovert.com/client/v2/lead-finder/imports",
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([
'schemaVersion' => 'people.v1',
'destination' => [
'listId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'campaignId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'moveOwnDuplicated' => true,
'onlyRecentlyActive' => true,
'listName' => null
],
'idempotencyKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'maxCreditsSpend' => 50,
'query' => [
'filters' => [
[
'field' => 'contact.titleLatest',
'op' => 'any.include',
'mode' => 'SMART',
'values' => [
'head of sales',
'sales director'
]
],
[
'field' => 'contact.seniority',
'op' => 'any.include',
'values' => [
'director',
'head',
'vp'
]
],
[
'field' => 'contact.location',
'op' => 'any.include',
'values' => [
'Germany'
]
],
[
'field' => 'account.industries',
'op' => 'any.include',
'mode' => 'SMART',
'values' => [
'software development'
]
],
[
'field' => 'account.employeeSize',
'op' => 'range',
'ranges' => [
[
'start' => 51,
'end' => 500
]
]
]
]
],
'count' => 50,
'providerIds' => [
'<string>'
]
]),
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.goextrovert.com/client/v2/lead-finder/imports"
payload := strings.NewReader("{\n \"schemaVersion\": \"people.v1\",\n \"destination\": {\n \"listId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"moveOwnDuplicated\": true,\n \"onlyRecentlyActive\": true,\n \"listName\": null\n },\n \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"maxCreditsSpend\": 50,\n \"query\": {\n \"filters\": [\n {\n \"field\": \"contact.titleLatest\",\n \"op\": \"any.include\",\n \"mode\": \"SMART\",\n \"values\": [\n \"head of sales\",\n \"sales director\"\n ]\n },\n {\n \"field\": \"contact.seniority\",\n \"op\": \"any.include\",\n \"values\": [\n \"director\",\n \"head\",\n \"vp\"\n ]\n },\n {\n \"field\": \"contact.location\",\n \"op\": \"any.include\",\n \"values\": [\n \"Germany\"\n ]\n },\n {\n \"field\": \"account.industries\",\n \"op\": \"any.include\",\n \"mode\": \"SMART\",\n \"values\": [\n \"software development\"\n ]\n },\n {\n \"field\": \"account.employeeSize\",\n \"op\": \"range\",\n \"ranges\": [\n {\n \"start\": 51,\n \"end\": 500\n }\n ]\n }\n ]\n },\n \"count\": 50,\n \"providerIds\": [\n \"<string>\"\n ]\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.goextrovert.com/client/v2/lead-finder/imports")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"schemaVersion\": \"people.v1\",\n \"destination\": {\n \"listId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"moveOwnDuplicated\": true,\n \"onlyRecentlyActive\": true,\n \"listName\": null\n },\n \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"maxCreditsSpend\": 50,\n \"query\": {\n \"filters\": [\n {\n \"field\": \"contact.titleLatest\",\n \"op\": \"any.include\",\n \"mode\": \"SMART\",\n \"values\": [\n \"head of sales\",\n \"sales director\"\n ]\n },\n {\n \"field\": \"contact.seniority\",\n \"op\": \"any.include\",\n \"values\": [\n \"director\",\n \"head\",\n \"vp\"\n ]\n },\n {\n \"field\": \"contact.location\",\n \"op\": \"any.include\",\n \"values\": [\n \"Germany\"\n ]\n },\n {\n \"field\": \"account.industries\",\n \"op\": \"any.include\",\n \"mode\": \"SMART\",\n \"values\": [\n \"software development\"\n ]\n },\n {\n \"field\": \"account.employeeSize\",\n \"op\": \"range\",\n \"ranges\": [\n {\n \"start\": 51,\n \"end\": 500\n }\n ]\n }\n ]\n },\n \"count\": 50,\n \"providerIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goextrovert.com/client/v2/lead-finder/imports")
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 \"schemaVersion\": \"people.v1\",\n \"destination\": {\n \"listId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"moveOwnDuplicated\": true,\n \"onlyRecentlyActive\": true,\n \"listName\": null\n },\n \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"maxCreditsSpend\": 50,\n \"query\": {\n \"filters\": [\n {\n \"field\": \"contact.titleLatest\",\n \"op\": \"any.include\",\n \"mode\": \"SMART\",\n \"values\": [\n \"head of sales\",\n \"sales director\"\n ]\n },\n {\n \"field\": \"contact.seniority\",\n \"op\": \"any.include\",\n \"values\": [\n \"director\",\n \"head\",\n \"vp\"\n ]\n },\n {\n \"field\": \"contact.location\",\n \"op\": \"any.include\",\n \"values\": [\n \"Germany\"\n ]\n },\n {\n \"field\": \"account.industries\",\n \"op\": \"any.include\",\n \"mode\": \"SMART\",\n \"values\": [\n \"software development\"\n ]\n },\n {\n \"field\": \"account.employeeSize\",\n \"op\": \"range\",\n \"ranges\": [\n {\n \"start\": 51,\n \"end\": 500\n }\n ]\n }\n ]\n },\n \"count\": 50,\n \"providerIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"importId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"listId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replayed": true
},
"message": "Operation completed successfully"
}{
"status": "error",
"data": null,
"message": "An error occurred while processing the request"
}{
"status": "error",
"data": null,
"message": "An error occurred while processing the request"
}{
"status": "error",
"data": null,
"message": "An error occurred while processing the request"
}{
"status": "error",
"data": null,
"message": "An error occurred while processing the request"
}{
"status": "error",
"data": null,
"message": "An error occurred while processing the request"
}Authorizations
API Key for authentication
Body
application/json
FILTERS requests the first count of query matches, not the next page of unimported people; SELECTED uses distinct preview providerIds. Selected IDs not returned by the provider are skipped, so delivery is not guaranteed.
Available options:
FILTERS, SELECTED The version the search schema currently reports, e.g. people.v1. Any other value is refused.
Minimum string length:
1Example:
"people.v1"
Where the prospects land. Exactly one of listId and listName is set; the other is omitted or null.
- Existing list
- New list
Show child attributes
Show child attributes
A UUID v4 the caller generates for this purchase; reuse it only to retry the same purchase.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$The most credits this import may charge: count × 1 for FILTERS, the number of distinct providerIds × 1 for SELECTED; 1 credit per retrieved prospect. The start is refused when the cost could exceed it.
Required range:
0 <= x <= 2147483647Example:
50
FILTERS only: the people-search query, the flat list of conditions {"filters":[…]} in the grammar Get Lead Finder Search Schema publishes — the same query the preview took. Omit for SELECTED: it does not select or exclude people, although a supplied query still must pass the gateway’s input validation. A key the grammar does not accept is refused, naming it; no key is dropped silently.
Show child attributes
Show child attributes
Example:
{
"filters": [
{
"field": "contact.titleLatest",
"op": "any.include",
"mode": "SMART",
"values": ["head of sales", "sales director"]
},
{
"field": "contact.seniority",
"op": "any.include",
"values": ["director", "head", "vp"]
},
{
"field": "contact.location",
"op": "any.include",
"values": ["Germany"]
},
{
"field": "account.industries",
"op": "any.include",
"mode": "SMART",
"values": ["software development"]
},
{
"field": "account.employeeSize",
"op": "range",
"ranges": [{ "start": 51, "end": 500 }]
}
]
}
FILTERS: required number of matches to request, taken from the top of the query's matches in preview order. Omit for SELECTED: selection uses distinct providerIds, not count. If supplied, count still must pass the input type and bounds. A count above the Prospect Capacity left, above what the balance covers or above the search schema's limits.resultCeiling is refused before anything starts; an import is never trimmed to fit. Asking for more than grossTotal buys nothing extra: the import stops when the matches run out and charges only what it retrieved. People already imported from this query are among its first matches: they are retrieved and charged again and count as already in prospects, so to add other people import SELECTED rows not yet imported.
Required range:
1 <= x <= 2147483647Example:
50
SELECTED: providerId values from preview, 1 to 100; a repeated id counts once. Omit for FILTERS: they do not limit, exclude, or add query matches. If supplied, the array still must pass input validation.
Required array length:
1 - 100 elementsMinimum string length:
1