Skip to content
Lightfield Lightfield
API Reference

Enrichment Run

Enrichment fills in missing information on a record from Lightfield’s data providers.

Enrich a record
client.enrichmentRun.enrich(stringentityID, EnrichmentRunEnrichParams { entitySlug, fields } params, RequestOptionsoptions?): EnrichmentRunEnrichResponse { enrichmentRun, reason, status }
POST/v1/enrichmentRun/{entitySlug}/{entityId}
Get enrichment run status
client.enrichmentRun.getEnrichmentRun(stringrunID, RequestOptionsoptions?): EnrichmentRunGetEnrichmentRunResponse { id, completedAt, createdAt, 7 more }
GET/v1/enrichmentRun/{runId}
ModelsExpand Collapse
EnrichmentRunEnrichResponse { enrichmentRun, reason, status }
enrichmentRun: EnrichmentRun | null

The run, or null when the request was skipped.

id: string

The enrichment run ID.

completedAt: string | null

When the run finished, or null while it is still open.

createdAt: string
entityId: string

The ID of the record being enriched.

entityType: "contact" | "account"

The type of record being enriched.

One of the following:
"contact"
"account"
startedAt: string | null

When the run began executing, or null while it is queued.

status: "queued" | "running" | "completed" | 2 more

Where the run is: queued and running are in flight; completed, failed and timed_out are final.

One of the following:
"queued"
"running"
"completed"
"failed"
"timed_out"
targetFields: Array<string>

The fields this run set out to fill.

trigger: "creation" | "manual"

What started the run: creation when the record was created, manual when requested through the API.

One of the following:
"creation"
"manual"
updatedAt: string
reason: "no_targets" | "no_operations" | null

Why the request was skipped: no_targets when the workspace enriches nothing this record is missing, no_operations when no provider can be scheduled for the targeted fields — because none looks them up on request, or because the record lacks the inputs (such as an email or domain) a lookup would need. Null otherwise.

One of the following:
"no_targets"
"no_operations"
status: "started" | "already_running" | "skipped"

started when this request began a run, already_running when one was already enriching the record, skipped when there was nothing to enrich.

One of the following:
"started"
"already_running"
"skipped"
EnrichmentRunGetEnrichmentRunResponse { id, completedAt, createdAt, 7 more }
id: string

The enrichment run ID.

completedAt: string | null

When the run finished, or null while it is still open.

createdAt: string
entityId: string

The ID of the record being enriched.

entityType: "contact" | "account"

The type of record being enriched.

One of the following:
"contact"
"account"
startedAt: string | null

When the run began executing, or null while it is queued.

status: "queued" | "running" | "completed" | 2 more

Where the run is: queued and running are in flight; completed, failed and timed_out are final.

One of the following:
"queued"
"running"
"completed"
"failed"
"timed_out"
targetFields: Array<string>

The fields this run set out to fill.

trigger: "creation" | "manual"

What started the run: creation when the record was created, manual when requested through the API.

One of the following:
"creation"
"manual"
updatedAt: string