Skip to main content
GET
/
v3
/
live-data
/
searches
/
{id}
Get a Live Data search
curl --request GET \
  --url https://api.reply.io/v3/live-data/searches/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "startedAt": "2023-11-07T05:31:56Z",
  "contactsFound": 123,
  "usedCredits": 123,
  "userId": 123,
  "sequenceId": 123,
  "sequenceName": "<string>",
  "lists": [
    {
      "id": 123,
      "name": "<string>"
    }
  ],
  "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>"
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

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.

Path Parameters

id
integer
required

Search id

Required range: x >= 1

Response

Search found

A single Live Data search, including the filters it was run with.

id
integer
required

Search id

status
enum<string>
required

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.
Available options:
inProgress,
finished,
noMoreContacts,
manuallyPaused,
pausedDueToInsufficientCredits
startedAt
string<date-time>
required

When the search started (UTC)

contactsFound
integer

Number of contacts found and added so far

usedCredits
integer

Total credits spent by the search (contacts + emails + phones)

userId
integer

Id of the user who started the search

sequenceId
integer | null

Sequence the found contacts are added to, when configured

sequenceName
string | null

Name of the target sequence, when configured

lists
object[]

Prospect lists the found contacts are added to

filters
Live Data filters · object

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