Entities
Golden records — one per real-world thing, assembled from every source that describes it.
Find duplicate candidates for a record
Scores this record against the tenant's other records using the active match profile and returns the candidates with their evidence. Run with a dry run to preview candidates without recording anything; otherwise confirmed matches are queued for a steward. Requires `entity.match`.
Create a record
Creates a golden record of the given entity type. Attribute values are standardized on the way in and scored for quality, so what is stored is the canonical form rather than the raw input. Requires `entity.create`.
List records
Returns golden records, paginated and filterable by type, status and quality score. Records merged into another are hidden unless you ask for them. Values the caller may not see are masked before the response leaves the platform. Requires `entity.read`.
Load source records in bulk
Attaches many source records to their golden records in one call. Use this for an initial load or a periodic sync from a source system rather than issuing one request per record. Requires `entity.source-record.create`.
Create relationships in bulk
Creates many relationships in one call. Endpoints are resolved to their surviving golden record, so a relationship pointing at a record that has since been merged still lands on the survivor. Requires `entity.relationship.create`.
Get a record
Returns one golden record with its attributes and their provenance. Requesting a record that has been merged returns the survivor, and the response says so. Requires `entity.read`.
Update a record
Changes a record's own fields. Attribute values are managed through the record's attributes collection rather than here. Requires `entity.update`.
Delete a record
Soft-deletes the record. It stops appearing in reads and can be restored; nothing is destroyed. Requires `entity.delete`.
Get a record's change history
Returns the record's changes over time, oldest change last. Every value the platform has held is recoverable here. Requires `entity.read`.
Get a record's lineage
Returns where the record's current values came from — which source contributed each one and which survivorship rule chose it. Requires `entity.read`.
Get the 360 view of a record
Returns the record assembled from every angle at once: attributes with provenance, contributing source records, relationships, merge history and quality. This is the single call behind the console's record view. Requires `entity.read`.
Restore a deleted record
Reinstates a soft-deleted record with its attributes and relationships intact. Requires `entity.restore`.