Preview a Live Data search
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.
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
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" }).
Maximum contacts to consider per company. Optional; defaults to 1 when omitted.
x >= 1Response
Preview accepted; poll the returned job for progress and results
Background job id; poll GET /v3/background-jobs/{id}.