Skip to main content
GET
Get Company 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 companies and no summary. Once it is done it answers 200 OK with status set to terminated 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.

Reading the result

An on_hold Company Finder search does not resume after a top up. Top up, then submit the search again. Nothing was charged for the first one.
Put a timeout on your polling loop. If the search provider fails, the request can stay in processing instead of moving to a final status.
credits_left and credits_consumed are returned as decimal strings, for example "998.5". Parse them before doing arithmetic.

Authorizations

X-API-Key
string
header
required

Path Parameters

request_id
string
required

The request_id returned by POST /company_finder/async.

Response

Search finished. status is terminated (companies and summary present, companies possibly empty) or on_hold (not enough credits for a single company).

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 companies array.

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

"terminated"

credits_consumed
string

Credits spent by this search, as a decimal string.

Example:

"2.5"

credits_left
string

Credits remaining on the account, as a decimal string.

Example:

"998.5"

summary
object

Only present once status is terminated.

companies
object[]

Only present once status is terminated. An empty array when nothing matched.