v9

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01234055.7 KB

Entity Graph

Get entity relationship graph as flat nodes and edges

Retrieves the entity relationship graph as a flat nodes-and-edges structure, suitable for frontend visualization tools such as React Flow, Vis.js, and Cytoscape.

get/api/v1/entities/{templateIdentifier}/{entityIdentifier}/graph

Path parameters

templateIdentifierstring required

entityIdentifierstring required

Query parameters

depthinteger

Maximum traversal depth for relationship resolution. Clamped between 1 and 6.

include_databoolean

When true, each graph node includes a data object containing the entity's property values. Defaults to false.

traversal_mode'DIRECT_LINEAGE' | 'BIDIRECTIONAL' | 'OUTBOUND_ONLY'

Specifies the traversal mode for the entity graph. Defaults to DIRECT_LINEAGE.

relationsstring[]

When provided, only relations whose name matches one of the listed values are traversed and included. Omit to include all relations.

propertiesstring[]

When provided, each node's data object is restricted to the listed property names. Requires include_data=true to have any effect. Omit to include all properties.

Response

Flat entity graph successfully retrieved