v36

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0187270483.0 KB
Knowledge Graph

Get an Entity's Relations

get/v3/entities/{id}/relations

Path parameters

idstring required

Entity public ID (ent_...). A merged-away id transparently resolves to the surviving entity.

Query parameters

direction'inbound' | 'outbound' | 'both'

Which edges to return relative to the entity. Defaults to both.

relationTypestring

Exact-match filter on the relation label.

limitinteger

Maximum number of edges to return (default 50, max 200).

cursorstring

Cursor: return edges whose KSUID sorts after this value.

bucketstring

Optional bucket public ID (bkt_...) to scope the read to one bucket. Omit for the unscoped (all account+environment) view.

Response

The request has succeeded.

nextCursorstring

Opaque cursor for the next page of edges, or absent on the last page. Pass it back as cursor.