Preview a Live Data search
curl --request POST \
--url https://api.reply.io/v3/live-data/searches/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"accountListIds": [
{
"value": 2
}
],
"industries": [
{
"value": "<string>"
}
],
"companyLocations": [
{
"value": "<string>"
}
],
"companySizes": [],
"headcountGrowth": {
"min": 1,
"max": 1
},
"departmentHeadcountGrowth": {
"department": "<string>",
"min": 1,
"max": 1
},
"accountKeywords": {
"values": [
{
"value": "<string>"
}
]
},
"isHiringOnLinkedIn": true,
"contactLocations": [
{
"value": "<string>"
}
],
"jobTitles": [
{
"value": "<string>"
}
],
"departments": [
{
"value": "<string>"
}
],
"seniorities": [
"<string>"
],
"contactKeywords": {
"values": [
{
"value": "<string>"
}
]
}
},
"maxPeoplePerCompany": 1
}
'import requests
url = "https://api.reply.io/v3/live-data/searches/preview"
payload = {
"filters": {
"accountListIds": [{ "value": 2 }],
"industries": [{ "value": "<string>" }],
"companyLocations": [{ "value": "<string>" }],
"companySizes": [],
"headcountGrowth": {
"min": 1,
"max": 1
},
"departmentHeadcountGrowth": {
"department": "<string>",
"min": 1,
"max": 1
},
"accountKeywords": { "values": [{ "value": "<string>" }] },
"isHiringOnLinkedIn": True,
"contactLocations": [{ "value": "<string>" }],
"jobTitles": [{ "value": "<string>" }],
"departments": [{ "value": "<string>" }],
"seniorities": ["<string>"],
"contactKeywords": { "values": [{ "value": "<string>" }] }
},
"maxPeoplePerCompany": 1
}
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({
filters: {
accountListIds: [{value: 2}],
industries: [{value: '<string>'}],
companyLocations: [{value: '<string>'}],
companySizes: [],
headcountGrowth: {min: 1, max: 1},
departmentHeadcountGrowth: {department: '<string>', min: 1, max: 1},
accountKeywords: {values: [{value: '<string>'}]},
isHiringOnLinkedIn: true,
contactLocations: [{value: '<string>'}],
jobTitles: [{value: '<string>'}],
departments: [{value: '<string>'}],
seniorities: ['<string>'],
contactKeywords: {values: [{value: '<string>'}]}
},
maxPeoplePerCompany: 1
})
};
fetch('https://api.reply.io/v3/live-data/searches/preview', 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.reply.io/v3/live-data/searches/preview",
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([
'filters' => [
'accountListIds' => [
[
'value' => 2
]
],
'industries' => [
[
'value' => '<string>'
]
],
'companyLocations' => [
[
'value' => '<string>'
]
],
'companySizes' => [
],
'headcountGrowth' => [
'min' => 1,
'max' => 1
],
'departmentHeadcountGrowth' => [
'department' => '<string>',
'min' => 1,
'max' => 1
],
'accountKeywords' => [
'values' => [
[
'value' => '<string>'
]
]
],
'isHiringOnLinkedIn' => true,
'contactLocations' => [
[
'value' => '<string>'
]
],
'jobTitles' => [
[
'value' => '<string>'
]
],
'departments' => [
[
'value' => '<string>'
]
],
'seniorities' => [
'<string>'
],
'contactKeywords' => [
'values' => [
[
'value' => '<string>'
]
]
]
],
'maxPeoplePerCompany' => 1
]),
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.reply.io/v3/live-data/searches/preview"
payload := strings.NewReader("{\n \"filters\": {\n \"accountListIds\": [\n {\n \"value\": 2\n }\n ],\n \"industries\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"companyLocations\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"companySizes\": [],\n \"headcountGrowth\": {\n \"min\": 1,\n \"max\": 1\n },\n \"departmentHeadcountGrowth\": {\n \"department\": \"<string>\",\n \"min\": 1,\n \"max\": 1\n },\n \"accountKeywords\": {\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n },\n \"isHiringOnLinkedIn\": true,\n \"contactLocations\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"jobTitles\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"departments\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"seniorities\": [\n \"<string>\"\n ],\n \"contactKeywords\": {\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n },\n \"maxPeoplePerCompany\": 1\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))
}HttpResponse<String> response = Unirest.post("https://api.reply.io/v3/live-data/searches/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"accountListIds\": [\n {\n \"value\": 2\n }\n ],\n \"industries\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"companyLocations\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"companySizes\": [],\n \"headcountGrowth\": {\n \"min\": 1,\n \"max\": 1\n },\n \"departmentHeadcountGrowth\": {\n \"department\": \"<string>\",\n \"min\": 1,\n \"max\": 1\n },\n \"accountKeywords\": {\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n },\n \"isHiringOnLinkedIn\": true,\n \"contactLocations\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"jobTitles\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"departments\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"seniorities\": [\n \"<string>\"\n ],\n \"contactKeywords\": {\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n },\n \"maxPeoplePerCompany\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.reply.io/v3/live-data/searches/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"accountListIds\": [\n {\n \"value\": 2\n }\n ],\n \"industries\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"companyLocations\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"companySizes\": [],\n \"headcountGrowth\": {\n \"min\": 1,\n \"max\": 1\n },\n \"departmentHeadcountGrowth\": {\n \"department\": \"<string>\",\n \"min\": 1,\n \"max\": 1\n },\n \"accountKeywords\": {\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n },\n \"isHiringOnLinkedIn\": true,\n \"contactLocations\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"jobTitles\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"departments\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"seniorities\": [\n \"<string>\"\n ],\n \"contactKeywords\": {\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n },\n \"maxPeoplePerCompany\": 1\n}"
response = http.request(request)
puts response.read_body{
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"title": "Bad Request",
"status": 400,
"detail": "Filters are invalid.",
"code": "liveDataSearch.invalidParameter"
}{
"title": "Unauthorized",
"status": 401,
"detail": "Authentication credentials are missing or invalid."
}{
"title": "Conflict",
"status": 409,
"detail": "A live data search is already in progress.",
"code": "liveDataSearch.searchInProgress"
}{
"title": "Bad Gateway",
"status": 502,
"detail": "Upstream service failure: ...",
"code": "liveDataSearch.upstreamFailure"
}Live Data
Preview a Live Data search
Beta. This endpoint is in beta. Behavior, parameters, and response shapes may change without notice.
contacts:write scope (or a broader one that includes it).
Starts a Live Data preview for the given filters and returns a background job to poll. The job is tracked by GET /v3/background-jobs/{id}; on completion its jsonDataResult carries { contactsCount, companiesCount, sampleContacts }, where sampleContacts is a capped sample of matching contacts. A preview adds no prospects and consumes no credits.
POST
/
v3
/
live-data
/
searches
/
preview
Preview a Live Data search
curl --request POST \
--url https://api.reply.io/v3/live-data/searches/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"accountListIds": [
{
"value": 2
}
],
"industries": [
{
"value": "<string>"
}
],
"companyLocations": [
{
"value": "<string>"
}
],
"companySizes": [],
"headcountGrowth": {
"min": 1,
"max": 1
},
"departmentHeadcountGrowth": {
"department": "<string>",
"min": 1,
"max": 1
},
"accountKeywords": {
"values": [
{
"value": "<string>"
}
]
},
"isHiringOnLinkedIn": true,
"contactLocations": [
{
"value": "<string>"
}
],
"jobTitles": [
{
"value": "<string>"
}
],
"departments": [
{
"value": "<string>"
}
],
"seniorities": [
"<string>"
],
"contactKeywords": {
"values": [
{
"value": "<string>"
}
]
}
},
"maxPeoplePerCompany": 1
}
'import requests
url = "https://api.reply.io/v3/live-data/searches/preview"
payload = {
"filters": {
"accountListIds": [{ "value": 2 }],
"industries": [{ "value": "<string>" }],
"companyLocations": [{ "value": "<string>" }],
"companySizes": [],
"headcountGrowth": {
"min": 1,
"max": 1
},
"departmentHeadcountGrowth": {
"department": "<string>",
"min": 1,
"max": 1
},
"accountKeywords": { "values": [{ "value": "<string>" }] },
"isHiringOnLinkedIn": True,
"contactLocations": [{ "value": "<string>" }],
"jobTitles": [{ "value": "<string>" }],
"departments": [{ "value": "<string>" }],
"seniorities": ["<string>"],
"contactKeywords": { "values": [{ "value": "<string>" }] }
},
"maxPeoplePerCompany": 1
}
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({
filters: {
accountListIds: [{value: 2}],
industries: [{value: '<string>'}],
companyLocations: [{value: '<string>'}],
companySizes: [],
headcountGrowth: {min: 1, max: 1},
departmentHeadcountGrowth: {department: '<string>', min: 1, max: 1},
accountKeywords: {values: [{value: '<string>'}]},
isHiringOnLinkedIn: true,
contactLocations: [{value: '<string>'}],
jobTitles: [{value: '<string>'}],
departments: [{value: '<string>'}],
seniorities: ['<string>'],
contactKeywords: {values: [{value: '<string>'}]}
},
maxPeoplePerCompany: 1
})
};
fetch('https://api.reply.io/v3/live-data/searches/preview', 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.reply.io/v3/live-data/searches/preview",
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([
'filters' => [
'accountListIds' => [
[
'value' => 2
]
],
'industries' => [
[
'value' => '<string>'
]
],
'companyLocations' => [
[
'value' => '<string>'
]
],
'companySizes' => [
],
'headcountGrowth' => [
'min' => 1,
'max' => 1
],
'departmentHeadcountGrowth' => [
'department' => '<string>',
'min' => 1,
'max' => 1
],
'accountKeywords' => [
'values' => [
[
'value' => '<string>'
]
]
],
'isHiringOnLinkedIn' => true,
'contactLocations' => [
[
'value' => '<string>'
]
],
'jobTitles' => [
[
'value' => '<string>'
]
],
'departments' => [
[
'value' => '<string>'
]
],
'seniorities' => [
'<string>'
],
'contactKeywords' => [
'values' => [
[
'value' => '<string>'
]
]
]
],
'maxPeoplePerCompany' => 1
]),
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.reply.io/v3/live-data/searches/preview"
payload := strings.NewReader("{\n \"filters\": {\n \"accountListIds\": [\n {\n \"value\": 2\n }\n ],\n \"industries\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"companyLocations\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"companySizes\": [],\n \"headcountGrowth\": {\n \"min\": 1,\n \"max\": 1\n },\n \"departmentHeadcountGrowth\": {\n \"department\": \"<string>\",\n \"min\": 1,\n \"max\": 1\n },\n \"accountKeywords\": {\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n },\n \"isHiringOnLinkedIn\": true,\n \"contactLocations\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"jobTitles\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"departments\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"seniorities\": [\n \"<string>\"\n ],\n \"contactKeywords\": {\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n },\n \"maxPeoplePerCompany\": 1\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))
}HttpResponse<String> response = Unirest.post("https://api.reply.io/v3/live-data/searches/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"accountListIds\": [\n {\n \"value\": 2\n }\n ],\n \"industries\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"companyLocations\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"companySizes\": [],\n \"headcountGrowth\": {\n \"min\": 1,\n \"max\": 1\n },\n \"departmentHeadcountGrowth\": {\n \"department\": \"<string>\",\n \"min\": 1,\n \"max\": 1\n },\n \"accountKeywords\": {\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n },\n \"isHiringOnLinkedIn\": true,\n \"contactLocations\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"jobTitles\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"departments\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"seniorities\": [\n \"<string>\"\n ],\n \"contactKeywords\": {\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n },\n \"maxPeoplePerCompany\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.reply.io/v3/live-data/searches/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"accountListIds\": [\n {\n \"value\": 2\n }\n ],\n \"industries\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"companyLocations\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"companySizes\": [],\n \"headcountGrowth\": {\n \"min\": 1,\n \"max\": 1\n },\n \"departmentHeadcountGrowth\": {\n \"department\": \"<string>\",\n \"min\": 1,\n \"max\": 1\n },\n \"accountKeywords\": {\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n },\n \"isHiringOnLinkedIn\": true,\n \"contactLocations\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"jobTitles\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"departments\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"seniorities\": [\n \"<string>\"\n ],\n \"contactKeywords\": {\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n },\n \"maxPeoplePerCompany\": 1\n}"
response = http.request(request)
puts response.read_body{
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"title": "Bad Request",
"status": 400,
"detail": "Filters are invalid.",
"code": "liveDataSearch.invalidParameter"
}{
"title": "Unauthorized",
"status": 401,
"detail": "Authentication credentials are missing or invalid."
}{
"title": "Conflict",
"status": 409,
"detail": "A live data search is already in progress.",
"code": "liveDataSearch.searchInProgress"
}{
"title": "Bad Gateway",
"status": 502,
"detail": "Upstream service failure: ...",
"code": "liveDataSearch.upstreamFailure"
}Authorizations
Authenticate every request with a Bearer token. Pass your Reply API key in the
Authorization header:
Authorization: Bearer <your-api-key>
Get your API key from the Reply dashboard: Settings → API Key.
Body
application/json
Filters to preview before running a full Live Data search.
Account- and contact-level filter configuration for a Live Data search.
Most collections are capped at 25 items. accountKeywords and contactKeywords are always present and non-null in responses even when empty ({ "values": [], "type": "or" }).
Show child attributes
Show child attributes
Maximum contacts to consider per company. Optional; defaults to 1 when omitted.
Required range:
x >= 1Response
Preview accepted; poll the returned job for progress and results
Background job id; poll GET /v3/background-jobs/{id}.
⌘I