Skip to content

Get enrichment run status

GET/v1/enrichmentRun/{runId}

Returns the status of an enrichment run by its ID.

Required scopes: contacts:read for a contact run, accounts:read for an account run

Rate limit category: Read

Path ParametersExpand Collapse
runId: string

The enrichment run ID.

ReturnsExpand Collapse
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

Get enrichment run status

curl https://api.lightfield.app/v1/enrichmentRun/$RUN_ID \
    -H 'Lightfield-Version: 2026-03-01' \
    -H "Authorization: Bearer $API_KEY"
{
  "id": "id",
  "completedAt": "completedAt",
  "createdAt": "createdAt",
  "entityId": "entityId",
  "entityType": "contact",
  "startedAt": "startedAt",
  "status": "queued",
  "targetFields": [
    "string"
  ],
  "trigger": "creation",
  "updatedAt": "updatedAt"
}
Returns Examples
{
  "id": "id",
  "completedAt": "completedAt",
  "createdAt": "createdAt",
  "entityId": "entityId",
  "entityType": "contact",
  "startedAt": "startedAt",
  "status": "queued",
  "targetFields": [
    "string"
  ],
  "trigger": "creation",
  "updatedAt": "updatedAt"
}