API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Enrichment Run

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

Enrich a record

POST/v1/enrichmentRun/{entitySlug}/{entityId}

Get enrichment run status

GET/v1/enrichmentRun/{runId}

ModelsExpand Collapse

EnrichmentRunEnrichResponse object { enrichmentRun, reason, status }

enrichmentRun: object { id, completedAt, createdAt, 7 more }

The run, or null when the request was skipped.

id: string

The enrichment run ID.

completedAt: string

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

createdAt: string

entityId: string

The ID of the record being enriched.

entityType: "contact" or "account"

The type of record being enriched.

One of the following:

"contact"

"account"

startedAt: string

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

status: "queued" or "running" or "completed" or 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 of string

The fields this run set out to fill.

trigger: "creation" or "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" or "no_operations"

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" or "already_running" or "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 object { id, completedAt, createdAt, 7 more }

id: string

The enrichment run ID.

completedAt: string

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

createdAt: string

entityId: string

The ID of the record being enriched.

entityType: "contact" or "account"

The type of record being enriched.

One of the following:

"contact"

"account"

startedAt: string

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

status: "queued" or "running" or "completed" or 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 of string

The fields this run set out to fill.

trigger: "creation" or "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