Skip to main content
GET
Get Lead Finder search results
Poll on status, not on the HTTP status code.While the search is running this endpoint answers 202 Accepted with a body that has no leads and no summary. Once it is done it answers 200 OK with status set to terminated, not_found or on_hold.Always branch on body.status, never on the HTTP code alone. See Request statuses for the full lifecycle and a polling recipe.
Prefer the webhook attribute of POST /lead_finder/async over polling. See Webhooks.

Authorizations

X-API-Key
string
header
required

Path Parameters

request_id
string
required

Response

Search finished. status is terminated (leads present, possibly empty) or on_hold (top up credits to resume).

id
string

The request_id of this search.

Example:

"bc39ffbfc24cf043b748"

status
enum<string>

See Request statuses. A search that matched nothing is reported as terminated with an empty leads array.

Available options:
not_started,
processing,
on_hold,
terminated
Example:

"terminated"

message
string

Human readable hint. Only present while the search is not terminated.

Example:

"Lead finder request is not terminated yet. Please try later"

credits_consumed
integer

Credits spent by this search. Zero unless enrich_email_address or enrich_phone_number was requested.

Example:

0

credits_left
integer

Credits remaining on the account.

Example:

331

summary
object

Only present once status is terminated.

leads
object[]

Only present once status is terminated. Empty array when nothing matched.