Skip to main content
POST
Start a Live Data search

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Get your API key from the Reply dashboard: Settings → API Key.

Body

application/json

Configuration for a Live Data search that adds found contacts as prospects.

filters
Live Data filters · object
required

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" }).

contactsCountToAdd
integer
required

Number of contacts to find and add

Required range: x >= 1
addContactsWithoutEmails
boolean

When true, contacts without an email address are still added

maxPeoplePerCompany
integer
default:1

Maximum contacts to add per company. Optional; defaults to 1 when omitted.

Required range: x >= 1
sequenceId
integer | null

Sequence to move the found contacts into

listIds
integer[]

Prospect lists to add the found contacts to

referenceUrl
string | null

Optional reference URL used to seed the search

searchContactPhones
boolean

When true, enrich phone numbers during the search

Response

Search started

searchId
integer
required

Id of the created search; poll GET /v3/live-data/searches/{id}.