get_relationships

readSince v1.0

Find relationships (connections) between nodes. Filter by relationship type, source node, target node, or node types. Source and target IDs accept both UUIDs and auto-IDs (e.g. REQ-42).

Parameters

Name	Type	Required	Default	Description
`source_type`	`String`	—		[get_relationships] Filter by the node type of the source node.
`locale`	`String`	—		[get_relationships] Optional locale code to return translated labels and descriptions.
`relationship_type`	`String`	—		[get_relationships] Filter by relationship type name.
`limit`	`Number`	—	50	[get_relationships] Maximum number of results to return. Default: 50, max: 200.
`target_node_id`	`String`	—		[get_relationships] Filter to relationships ending at this node ID (UUID or auto-ID).
`source_node_id`	`String`	—		[get_relationships] Filter to relationships starting from this node ID (UUID or auto-ID).
`target_type`	`String`	—		[get_relationships] Filter by the node type of the target node.

Example Request

{"relationship_type": "depends_on", "source_type": "Feature"}

Example Response

{"relationships": [{"id": "rel-1", "type": "depends_on", "source_id": "uuid-1", "target_id": "uuid-2"}]}