Kernel.ai: Kernel Get Firmographics Job

Reading firmographics status and terminal headcount, revenue, and location data.

Tool ID: kernel_get_firmographics_job

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'kernel_get_firmographics_job',
  {
    "job_id": "job_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute kernel_get_firmographics_job --input '{
  "job_id": "job_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "status": "pending"
  }
}

Use deepline describe kernel_get_firmographics_job --json for the latest machine-readable contract.

Input reference

Returns the status and result of a firmographic enrichment job. When status is completed, the record field contains the enriched firmographic data.

Name	Type	Required	Default	Details
`payload.job_id`	`string`	Yes	—	ID of the firmographic enrichment job

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.id`	`string`	No	—	Unique identifier for the job. Present when `status` is `pending`, `processing`, or `completed`.
`result.data.jobid`	`string`	No	—	Unique identifier for the job. Present only when `status` is `failed`.
`result.data.status`	`"pending" \| "processing" \| "completed" \| "failed"`	Yes	—	Current status of the job. Terminal states are `completed` and `failed`. Allowed: `pending`, `processing`, `completed`, `failed`.
`result.data.created_at`	`string`	No	—	ISO 8601 timestamp when the job was created. Format: `date-time`.
`result.data.completed_at`	`string`	No	—	ISO 8601 timestamp when the job reached a terminal state. Format: `date-time`.
`result.data.record`	`object`	No	—	—
`result.data.record.kernel_id`	`string`	Yes	—	The unique identifier for the entity in Kernel’s database.
`result.data.record.op_status`	`object \| null`	Yes	—	Operational status of the entity. `null` when not yet determined.
`result.data.record.op_status.operational_status`	`"Active" \| "Out of business" \| "Absorbed" \| "Undetermined" \| null`	No	—	Current operational status. Allowed: `Active`, `Out of business`, `Absorbed`, `Undetermined`, `null`.
`result.data.record.op_status.reasoning`	`string \| null`	No	—	Explanation of how the operational status was determined.
`result.data.record.location`	`object \| null`	Yes	—	Operating and registered addresses. `null` when not yet determined.
`result.data.record.location.operating`	`object \| null`	No	—	Operating address.
`result.data.record.location.operating.street`	`string \| null`	No	—	Street address.
`result.data.record.location.operating.city`	`string \| null`	No	—	City.
`result.data.record.location.operating.state`	`string \| null`	No	—	State or province.
`result.data.record.location.operating.country`	`string \| null`	No	—	Country.
`result.data.record.location.operating.postcode`	`string \| null`	No	—	ZIP or postal code.
`result.data.record.location.operating.reasoning`	`string \| null`	No	—	Explanation of how the address was determined.
`result.data.record.location.registered`	`object \| null`	No	—	Registered/legal address.
`result.data.record.location.registered.street`	`string \| null`	No	—	Street address.
`result.data.record.location.registered.city`	`string \| null`	No	—	City.
`result.data.record.location.registered.state`	`string \| null`	No	—	State or province.
`result.data.record.location.registered.country`	`string \| null`	No	—	Country.
`result.data.record.location.registered.postcode`	`string \| null`	No	—	ZIP or postal code.
`result.data.record.location.registered.reasoning`	`string \| null`	No	—	Explanation of how the address was determined.
`result.data.record.headcount`	`object \| null`	Yes	—	Headcount data. `null` when not yet determined.
`result.data.record.headcount.count`	`number \| null`	No	—	Recommended (headline) headcount. Kernel automatically picks the entity-direct or consolidated figure based on entity type. equals `count_entity` or `count_consolidated`.
`result.data.record.headcount.count_entity`	`number \| null`	No	—	Entity-direct headcount, excluding subsidiaries.
`result.data.record.headcount.count_consolidated`	`number \| null`	No	—	Consolidated headcount including subsidiaries.
`result.data.record.headcount.confidence`	`"HIGH" \| "MEDIUM" \| "LOW" \| null`	No	—	Confidence in the headcount figure. Allowed: `HIGH`, `MEDIUM`, `LOW`, `null`.
`result.data.record.headcount.reasoning`	`string \| null`	No	—	Explanation of how the headcount was determined.
`result.data.record.revenue`	`object \| null`	Yes	—	Revenue data. `null` when not yet determined.
`result.data.record.revenue.usd`	`number \| null`	No	—	Recommended (headline) annual revenue in USD. Kernel automatically picks the entity-direct or consolidated figure based on entity type. equals `usd_entity` or `consolidated_usd`.
`result.data.record.revenue.usd_entity`	`number \| null`	No	—	Entity-direct annual revenue in USD, excluding subsidiaries.
`result.data.record.revenue.consolidated_usd`	`number \| null`	No	—	Consolidated annual revenue in USD including subsidiaries.
`result.data.record.revenue.confidence`	`"HIGH" \| "MEDIUM" \| "LOW" \| null`	No	—	Confidence in the revenue figure. Allowed: `HIGH`, `MEDIUM`, `LOW`, `null`.
`result.data.record.revenue.local_currency`	`string \| null`	No	—	The local currency of the recommended source figure, before USD conversion.
`result.data.record.revenue.local_currency_entity`	`string \| null`	No	—	The local currency of the entity-direct source figure, before USD conversion.
`result.data.record.revenue.local`	`number \| null`	No	—	Recommended annual revenue in local currency, matching `usd`.
`result.data.record.revenue.local_entity`	`number \| null`	No	—	Entity-direct annual revenue in local currency.
`result.data.record.revenue.consolidated_local`	`number \| null`	No	—	Consolidated revenue in local currency.
`result.data.record.revenue.consolidated_currency`	`string \| null`	No	—	The currency of the consolidated source figure, before USD conversion.
`result.data.record.revenue.reasoning`	`string \| null`	No	—	Explanation of how the revenue figure was determined.
`result.data.record.revenue.source`	`"identified" \| "estimated" \| null`	No	—	Source of the revenue data. One of: `identified`, `estimated`. Allowed: `identified`, `estimated`, `null`.
`result.data.error_message`	`string`	No	—	Error message. Present when `status` is `failed`.
`result.data.error_type`	`string`	No	—	Machine-readable error type. Present when `status` is `failed`. One of: `kernel_id_not_found`, `unknown`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

This output schema is too large for an inline display. Read the complete live contract with deepline describe kernel_get_firmographics_job --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation