Skip to main content
GET
Get firmographic enrichment result
Poll this endpoint to check the status and retrieve the result of a firmographic enrichment job.

Status lifecycle

Jobs progress linearly to a terminal state:
Once a job reaches completed or failed, the status does not change.

Result structure

When status is completed, the record field contains the firmographic data with operational status, location, headcount, and revenue — each group including a reasoning field. For pending or processing jobs, only status is returned. For failed jobs, record is absent.

Example

curl
Response (200) — completed
Response (200) — pending
Response (200) — failed
confidence and reasoning fields may be null when the value is estimated or unavailable.

Polling guidance

  • Use exponential backoff between polls (start at 2 seconds, cap at 30 seconds).
  • Jobs that do not exist yet (or whose ID is unknown) return { "status": "pending" }.
  • Enrichment typically takes 30 seconds to 5 minutes depending on data availability.
For the full FirmographicResult schema, see Firmographic result.

Authorizations

x-api-key
string
header
required

Include your API key in the x-api-key header.

Path Parameters

job_id
string
required

ID of the firmographic enrichment job

Example:

"test-firmo-001"

Response

Job status response

status
enum<string>
required

Current status of the job. Terminal states are completed and failed.

Available options:
pending,
processing,
completed,
failed
id
string

Unique identifier for the job. Present when status is pending, processing, or completed.

Example:

"test-firmo-001"

jobid
string

Unique identifier for the job. Present only when status is failed.

Example:

"test-firmo-001"

created_at
string<date-time>

ISO 8601 timestamp when the job was created.

Example:

"2026-06-08T14:00:32.411Z"

completed_at
string<date-time>

ISO 8601 timestamp when the job reached a terminal state.

Example:

"2026-06-08T14:53:53.151Z"

record
object

Firmographic data. Present when status is completed.

error_message
string

Error message. Present when status is failed.

error_type
string

Machine-readable error type. Present when status is failed. One of: kernel_id_not_found, unknown.