Skip to main content
GET
Download company enrichment results

Authorizations

Authorization
string
header
required

API Token used for authentication. Example: "Authorization: Bearer {token}"

Path Parameters

id
string<uuid>
required

Query Parameters

format
string

Download format: json, ndjson, or csv. Defaults to json.

sig
string

The signature from a download URL in a status response. Not needed with the batch owner's credentials.

Maximum string length: 1024

Response

OK

batchId
string<uuid>
required

The batch ID.

kind
string
required

The task represented by the batch.

status
enum<string>
required

The batch state when the download started.

Available options:
pending,
running,
completed,
cancelling,
cancelled
creditsCharged
number<double>
required

The credits charged so far, in user-visible credits.

resultCount
integer<int32>
required

The number of records in results.

results
object[]
required

One record per eligible input domain, in input order. Pending and unsettled inputs are absent.