Skip to navigation

Walk the org-wide graph outward from an entity

View as Markdown

Returns { entities, edges } — the neighbourhood of an entity within the org-wide (org) graph, up to ?depth= hops (1-3, default 1). Neighbour entities carry id, type, name, distance; edges carry sourceId, targetId, relation, fileId. Org-admin only — requires the admin role; non-admins get a 403.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entityIdstringRequired

Query parameters

depthintegerOptional1-3Defaults to 1

Hops to walk, 1–3.

Response

Neighbouring entities and the connecting edges.
entitieslist of objects
edgeslist of objects