Live Data

Get a Live Data search

<Warning> **Coming soon.** This endpoint will be available by early July 2026. </Warning>

<small>Requires the contacts:read scope (or a broader one that includes it).</small>

Returns a single Live Data search by id, including its status, progress, and the filters it was run with.

get/v3/live-data/searches/{id}

Request

Path parameters

idinteger required

Search id

Response

Search found

idinteger required

Search id

status'inProgress' | 'finished' | 'noMoreContacts' | 'manuallyPaused' | 'pausedDueToInsufficientCredits' 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.
startedAtstring date-time required

When the search started (UTC)

contactsFoundinteger

Number of contacts found and added so far

usedCreditsinteger

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

userIdinteger

Id of the user who started the search

sequenceIdinteger nullable

Sequence the found contacts are added to, when configured

sequenceNamestring nullable

Name of the target sequence, when configured

Changes

No recorded changes to this operation across all 1 revision of this API.