> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reply.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get a Live Data search
>
**Coming soon.** This endpoint will be available by mid June 2026.
Returns a single Live Data search by id, including its status, progress, and the filters it was run with.
## OpenAPI
````yaml /api-reference/bundled.yaml get /v3/live-data/searches/{id}
openapi: 3.1.0
info:
version: 3.0.0
title: Reply API
description: API for managing email sequences, contacts, and automation workflows
servers:
- url: https://api.reply.io
security:
- bearerAuth: []
tags:
- name: User Account
description: Account information and authentication verification
- name: Accounts
description: Manage accounts (companies/organizations)
- name: AI SDR Insights
description: Read AI SDR insights for sequence contacts
- name: AI SDR Intent Signals
description: >-
Read Reply industry IDs and technology slugs used in AI SDR intent-signal
configuration (typeahead)
- name: AI SDR Sequences
description: >-
Manage AI SDR sequences and their AI SDR-specific settings — create, read
settings, partial update, autopilot enable/disable/force-start, approval
mode, generated step types, and playbook/knowledge-base connections
- name: AI SDR Web Search
description: Find contacts via AI-driven web search and review past searches
- name: Attachments
description: >-
Upload file attachments used across email templates, sequence steps, and
direct emails
- name: Account Lists
description: Manage account lists and account membership
- name: Background Jobs
description: >-
Track and cancel asynchronous background operations (e.g., email
validation)
- name: Custom Fields
description: Manage custom contact fields
- name: Direct Outreach
description: >-
Send one-off outreach directly to a contact outside of any sequence —
direct emails and LinkedIn connection requests, messages, InMails, and
voice messages
- name: Contact Blacklist Rules
description: Manage blacklist rules for domains, emails, and email exceptions
- name: Contact Enrichment
description: >-
Enrich contacts with emails, phone numbers, LinkedIn data, and AI-filled
custom fields
- name: Contact Lists
description: Manage contact lists and contact membership
- name: Contacts
description: Manage individual contacts
- name: Email Accounts
description: Manage email accounts used for sending and receiving
- name: Email Templates
description: Manage email templates and template folders
- name: Email Validations
description: Estimate and schedule asynchronous email validation jobs
- name: Holiday Calendars
description: Manage holiday calendars for scheduling
- name: Inbox
description: >-
Manage inbox threads and per-team thread categories — list/filter, read
state, replies, category assignment, and meeting-intent flagging
- name: LinkedIn Accounts
description: Manage LinkedIn accounts for outreach
- name: Live Data
description: >-
Find new contacts via Live Data searches and read typeahead values for the
Live Data / Autopilot filter sidebar
- name: AI SDR Knowledge Bases
description: >-
Manage AI SDR knowledge bases — collections of documents, links, reply
handlers, and reengagement cards that inform the agent's responses
- name: AI SDR Offers
description: >-
Manage AI SDR offers — bundles of company-context inputs (ICP, pain
points, value propositions, etc.) used to personalize outreach
- name: AI SDR Pending Approvals
description: >-
Review, send, regenerate, and provide feedback on AI-generated messages
awaiting human approval
- name: AI SDR Playbooks
description: >-
Manage AI SDR playbooks — tone, voice, and style guides applied during
personalized message generation
- name: Reports
description: >-
Generate and access performance reports across email, calls, tasks,
LinkedIn, and team performance
- name: Schedules
description: Manage email send schedules and timing
- name: Settings
description: Manage team and user settings
- name: Sequence Contacts
description: Manage contacts within sequences
- name: Sequence Email Accounts
description: Manage email accounts linked to sequences
- name: Sequence Folders
description: Organize sequences into folders
- name: Sequence LinkedIn Accounts
description: Manage LinkedIn accounts linked to sequences
- name: AI SDR Sequence Preview
description: >-
Read and regenerate per-contact previews of the messages a sequence will
send, and provide feedback on preview messages
- name: Sequence Steps
description: Manage individual steps in sequences
- name: Sequence Templates
description: Manage sequence templates
- name: Sequences
description: Manage email automation sequences
- name: AI SDR Strategist
description: Trigger AI Strategist runs
- name: Tasks
description: Manage tasks and to-do items
- name: Webhooks
description: Manage webhook subscriptions and inspect delivery history
paths:
/v3/live-data/searches/{id}:
get:
tags:
- Live Data
summary: Get a Live Data search
description: >-
**Coming soon.** This endpoint will be available by mid June 2026.
Returns a single Live Data search by id, including its status, progress,
and the filters it was run with.
operationId: GetLiveDataSearch
parameters:
- name: id
in: path
required: true
description: Search id
schema:
type: integer
minimum: 1
responses:
'200':
description: Search found
content:
application/json:
schema:
title: Live Data search details
description: >-
A single Live Data search, including the filters it was run
with.
allOf:
- type: object
title: Live Data search
description: Summary of a Live Data search.
required:
- id
- status
- startedAt
properties:
id:
type: integer
description: Search id
status:
type: string
title: Live Data search status
description: >-
Lifecycle status of a Live Data search.
- `inProgress` — actively searching and adding
contacts.
- `finished` — completed; the requested number of
contacts was added.
- `noMoreContacts` — completed; the audience was
exhausted before the requested count was reached.
- `manuallyPaused` — paused by the user.
- `pausedDueToInsufficientCredits` — paused because
the team ran out of credits.
enum:
- inProgress
- finished
- noMoreContacts
- manuallyPaused
- pausedDueToInsufficientCredits
startedAt:
type: string
format: date-time
description: When the search started (UTC)
contactsFound:
type: integer
description: Number of contacts found and added so far
usedCredits:
type: integer
description: >-
Total credits spent by the search (contacts + emails +
phones)
userId:
type: integer
description: Id of the user who started the search
sequenceId:
type: integer
nullable: true
description: >-
Sequence the found contacts are added to, when
configured
sequenceName:
type: string
nullable: true
description: Name of the target sequence, when configured
lists:
type: array
description: Prospect lists the found contacts are added to
items:
type: object
required:
- id
- name
properties:
id:
type: integer
name:
type: string
- type: object
properties:
filters:
type: object
title: Live Data filters
description: >-
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" }`).
properties:
accountListIds:
type: array
maxItems: 25
description: Saved account-list ids the search is scoped to
items:
type: object
title: Integer filter value
description: >-
A single integer value used in an autopilot
filter, with include/exclude polarity.
required:
- value
properties:
value:
type: integer
minimum: 1
description: The literal integer id to match
type:
allOf:
- type: string
title: Filter polarity
description: >-
Whether matching values are included in
or excluded from the autopilot search.
enum:
- include
- exclude
description: >-
Whether the value is included in or excluded
from the search. Defaults to `include`.
industries:
type: array
maxItems: 25
description: Industry filters
items:
type: object
title: Filter value
description: >-
A single string value used in an autopilot
filter, with include/exclude polarity.
required:
- value
properties:
value:
type: string
maxLength: 200
description: The literal value to match (non-empty)
type:
allOf:
- type: string
title: Filter polarity
description: >-
Whether matching values are included in
or excluded from the autopilot search.
enum:
- include
- exclude
description: >-
Whether the value is included in or excluded
from the search. Defaults to `include`.
companyLocations:
type: array
maxItems: 25
description: Company location filters
items:
type: object
title: Filter value
description: >-
A single string value used in an autopilot
filter, with include/exclude polarity.
required:
- value
properties:
value:
type: string
maxLength: 200
description: The literal value to match (non-empty)
type:
allOf:
- type: string
title: Filter polarity
description: >-
Whether matching values are included in
or excluded from the autopilot search.
enum:
- include
- exclude
description: >-
Whether the value is included in or excluded
from the search. Defaults to `include`.
companySizes:
type: array
maxItems: 25
description: Company size bands to include
items:
type: string
title: Company size
description: >-
Headcount band used when filtering companies for
autopilot search.
enum:
- none
- selfEmployed
- ten
- fifty
- twoHundred
- fiveHundred
- oneThousand
- fiveThousand
- tenThousand
- overTenThousand
headcountGrowth:
allOf:
- type: object
title: Headcount growth range
description: >-
Min/max range applied to the company's total
headcount growth (percent). Either bound may
be omitted.
When both are provided, `min` must be less
than or equal to `max`.
properties:
min:
type: integer
minimum: 0
nullable: true
description: Lower bound (inclusive), percent
max:
type: integer
minimum: 0
nullable: true
description: Upper bound (inclusive), percent
nullable: true
description: Overall company headcount growth range
departmentHeadcountGrowth:
allOf:
- type: object
title: Department headcount growth range
description: >-
Min/max range applied to a specific
department's headcount growth (percent).
Either bound may be omitted.
When both are provided, `min` must be less
than or equal to `max`.
required:
- department
properties:
min:
type: integer
minimum: 0
nullable: true
description: Lower bound (inclusive), percent
max:
type: integer
minimum: 0
nullable: true
description: Upper bound (inclusive), percent
department:
type: string
maxLength: 200
description: >-
Department name the growth range applies
to (non-empty)
nullable: true
description: Per-department headcount growth range
minRevenue:
allOf:
- type: string
title: Company revenue tier
description: >-
Annual revenue tier used when filtering
companies for autopilot search.
enum:
- zeroMillion
- halfMillion
- oneMillion
- twoAndHalfMillion
- fiveMillion
- tenMillion
- twentyMillion
- fiftyMillion
- oneHundredMillion
- fiveHundredMillion
- oneThousandMillion
- overOneThousandMillion
nullable: true
description: Minimum company revenue tier
maxRevenue:
allOf:
- type: string
title: Company revenue tier
description: >-
Annual revenue tier used when filtering
companies for autopilot search.
enum:
- zeroMillion
- halfMillion
- oneMillion
- twoAndHalfMillion
- fiveMillion
- tenMillion
- twentyMillion
- fiftyMillion
- oneHundredMillion
- fiveHundredMillion
- oneThousandMillion
- overOneThousandMillion
nullable: true
description: >-
Maximum company revenue tier. When both
`minRevenue` and `maxRevenue` are provided,
`minRevenue` must be less than or equal to
`maxRevenue`.
accountKeywords:
allOf:
- type: object
title: Keyword filter
description: >-
Boolean keyword filter applied to account or
contact searches.
In responses this field is always present and
non-null even when no keywords are configured
(`{ "values": [], "type": "or" }`).
properties:
values:
type: array
maxItems: 25
description: >-
Keyword values combined according to
`type`
items:
type: object
title: Filter value
description: >-
A single string value used in an
autopilot filter, with include/exclude
polarity.
required:
- value
properties:
value:
type: string
maxLength: 200
description: The literal value to match (non-empty)
type:
allOf:
- type: string
title: Filter polarity
description: >-
Whether matching values are included in
or excluded from the autopilot search.
enum:
- include
- exclude
description: >-
Whether the value is included in or
excluded from the search. Defaults to
`include`.
type:
allOf:
- type: string
title: Keyword combination
description: >-
Boolean combinator applied across
keyword filter values.
enum:
- or
- and
description: >-
Boolean combinator across `values`.
Defaults to `or`.
description: >-
Free-text keyword filter applied at the account
level. Always present and non-null in responses.
isHiringOnLinkedIn:
type: boolean
description: >-
When `true`, restrict to companies currently
hiring on LinkedIn. `false` (the default) applies
no filter — it is treated the same as omitting the
field.
contactLocations:
type: array
maxItems: 25
description: Contact location filters
items:
type: object
title: Filter value
description: >-
A single string value used in an autopilot
filter, with include/exclude polarity.
required:
- value
properties:
value:
type: string
maxLength: 200
description: The literal value to match (non-empty)
type:
allOf:
- type: string
title: Filter polarity
description: >-
Whether matching values are included in
or excluded from the autopilot search.
enum:
- include
- exclude
description: >-
Whether the value is included in or excluded
from the search. Defaults to `include`.
jobTitles:
type: array
maxItems: 25
description: Contact job-title filters
items:
type: object
title: Filter value
description: >-
A single string value used in an autopilot
filter, with include/exclude polarity.
required:
- value
properties:
value:
type: string
maxLength: 200
description: The literal value to match (non-empty)
type:
allOf:
- type: string
title: Filter polarity
description: >-
Whether matching values are included in
or excluded from the autopilot search.
enum:
- include
- exclude
description: >-
Whether the value is included in or excluded
from the search. Defaults to `include`.
departments:
type: array
maxItems: 25
description: Contact department filters
items:
type: object
title: Filter value
description: >-
A single string value used in an autopilot
filter, with include/exclude polarity.
required:
- value
properties:
value:
type: string
maxLength: 200
description: The literal value to match (non-empty)
type:
allOf:
- type: string
title: Filter polarity
description: >-
Whether matching values are included in
or excluded from the autopilot search.
enum:
- include
- exclude
description: >-
Whether the value is included in or excluded
from the search. Defaults to `include`.
seniorities:
type: array
maxItems: 25
description: Seniority slugs to include
items:
type: string
minLength: 1
maxLength: 200
contactKeywords:
allOf:
- type: object
title: Keyword filter
description: >-
Boolean keyword filter applied to account or
contact searches.
In responses this field is always present and
non-null even when no keywords are configured
(`{ "values": [], "type": "or" }`).
properties:
values:
type: array
maxItems: 25
description: >-
Keyword values combined according to
`type`
items:
type: object
title: Filter value
description: >-
A single string value used in an
autopilot filter, with include/exclude
polarity.
required:
- value
properties:
value:
type: string
maxLength: 200
description: The literal value to match (non-empty)
type:
allOf:
- type: string
title: Filter polarity
description: >-
Whether matching values are included in
or excluded from the autopilot search.
enum:
- include
- exclude
description: >-
Whether the value is included in or
excluded from the search. Defaults to
`include`.
type:
allOf:
- type: string
title: Keyword combination
description: >-
Boolean combinator applied across
keyword filter values.
enum:
- or
- and
description: >-
Boolean combinator across `values`.
Defaults to `or`.
description: >-
Free-text keyword filter applied at the contact
level. Always present and non-null in responses.
'401':
description: >-
Unauthorized. The response body is empty; check the
`WWW-Authenticate` header for the expected scheme.
content:
application/problem+json:
schema:
allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized (auth
middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope and
add additional
fields — see `business-problem.model.yaml` (adds `code`
slug) and
`validation-problem.model.yaml` (adds `errors[]` array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
- example:
title: Unauthorized
status: 401
detail: Authentication credentials are missing or invalid.
'404':
description: Search not found
content:
application/problem+json:
schema:
allOf:
- allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized
(auth middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope
and add additional
fields — see `business-problem.model.yaml` (adds
`code` slug) and
`validation-problem.model.yaml` (adds `errors[]`
array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
- type: object
properties:
code:
type: string
description: >-
Stable, machine-readable error slug in the form
`"."`.
* `resource` is the camelCased domain — e.g.
`sequence`,
`contact`, `inboxThread`, `blacklistDomainRule`.
* `variant` is the camelCased specific failure
mode — e.g.
`notFound`, `forbidden`, `duplicateName`, `globalRuleReadOnly`.
Use `code` for programmatic error handling; use
`detail` for
user-facing messages. Slugs are stable across
server-side enum
reorderings and never change meaning under a given
resource.
pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)+$
example: sequence.notFound
title: Business Problem
description: >-
Domain error response carrying a stable, namespaced error
slug.
Emitted for most 4xx responses (business 400, 403, 404,
409, …) and
for 503 when a downstream dependency is unavailable.
- example:
title: Not Found
status: 404
detail: The requested resource was not found.
code: sequence.notFound
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Authenticate every request with a Bearer token. Pass your Reply API key
in the
`Authorization` header:
```
Authorization: Bearer
```
Get your API key from the Reply dashboard: **Settings → API Key**.
````