Skip to main content
GET
Get current enrichment data

Overview

Returns the current enrichment snapshot for an entity: the last merged mapped data and raw responses stored after enrichments ran. This endpoint is a read. It does not call external integrations and does not consume enrichment credits. To run integrations, use Execute enrichment. Use this when you need per-integration payloads (mapped / raw keyed by codes such as br_cpf_enrichment). For the Gu1 canonical dossier used by rules (enrichmentData.normalized.*), use Get normalized enrichment. Requires granular permission entities:read on the API key (legacy fallback entities:read).

Endpoint

Authentication

Path parameters

string
required
Gu1 entity UUID (path param name in the API is entityId).

Response

Envelope: { "success": true, "data": { ... } }.

When data exists (hasEnrichmentData: true)

string
Entity UUID.
boolean
true when a current snapshot row exists.
string
Snapshot status (typically completed).
string
ISO 8601 timestamp of the last enrichment that updated this snapshot.
string
User UUID that triggered the last run, or "system".
number
Duration of the last run in milliseconds, when recorded.
object
Consolidated mapped fields (Gu1 mapping). Keys are typically integration codes; values are the mapped objects for that code.
object
Raw upstream payloads keyed by integration code. Shape varies by integration; do not treat it as a stable Gu1 schema.
array
Integration codes present in this snapshot. JSON field name is providersUsed.
string
Optional short summary of the last run.
string
UUID of the related normalized enrichment row, when linked.
string
ISO 8601 timestamp when the snapshot row was created.
string
ISO 8601 timestamp of the last snapshot update.

When the entity exists but has no snapshot

HTTP 200 with hasEnrichmentData: false (not a 404):
This is different from normalized enrichment, which returns 404 when no normalized row exists.

Errors

Example

mapped and raw in production are larger and differ by integration. Treat the sample as a shape hint.