Skip to main content
GET
Fetch one saved lead search, including the results it returned.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

searchId
string
required

Query Parameters

companyId
string

Company ID that owns the list. Required when authenticating with a personal access key (pak_…) — the key is not tied to a specific company so the server cannot infer it. Required when authenticating with a company API key only if the key belongs to a user who has access to multiple companies; otherwise it defaults to the key's company. Optional for JWT (dashboard) auth — defaults to the user's active company.

Response

The saved search and its results

A saved lead search and the rows it returned, exactly as returned. Each row's keys are smart-list field names, so a selection can be posted straight to POST /lists/{listId}/rows with createColumns=true — no need to pay to run the search again. This is also the endpoint to poll while a search is running: check status, and treat results as final only once it is 'complete'.

id
string

Search ID (UUID).

source
string

Which surface ran the search. One of: sales_navigator, enrichment.

label
string

Short human-readable summary of the query.

query
object

The search as it was submitted, in the shape that surface accepts — enough to run it again.

status
enum<string>

Where the search is up to. One of: pending, complete, failed. 'pending' means it is still running — poll until it changes. 'complete' means results is final (possibly empty, if nothing matched). 'failed' means it did not run to completion and nothing was charged; see error.

Available options:
pending,
complete,
failed
error
string

Why the search failed. Null unless status is 'failed'.

resultCount
integer

How many results the search returned. May exceed the number of rows stored for very large searches.

creditsCharged
integer

Data credits charged for this search.

createdBy
string

User ID of whoever ran the search.

createdDate
string

ISO 8601 timestamp of when the search ran.

results
object[]

The stored result rows. Empty while status is 'pending'.

fieldLabels
object

Display label for each field present in the results, for use as table column headers.

priorityFields
string[]

Field names to show first, in order, when rendering the results as a table.