---
title: "Read project neighbors with bounded depth"
method: GET
path: "/api/project-graph/:projectId/neighbors"
tags: ["Project graph"]
---

# Read project neighbors with bounded depth

`GET /api/project-graph/:projectId/neighbors`

## Request

- Base URL: `https://api.cernion.de`
- URL: `https://api.cernion.de/api/project-graph/:projectId/neighbors`
- Auth: none declared

## Path parameters

- `projectId` string, required

## Query parameters

- `nodeId` string, required
- `relation` string
- `depth` integer
- `limit` integer
- `token` string

## Response `200`

Visible project graph; bounded traversal and provenance

- object
  - `nodes` object[]
    - `nodeId` string, required
    - `projectId` string, required
    - `kind` 'object' | 'dataset' | 'section' | 'entity' | 'skill' | 'external', required
    - `ref` unknown, required
    - `labels` string[], required
    - `attributes` object, required
    - `provenance` object, required
    - `derivation` object, required
      - `version` string
  - `edges` object[]
    - `edgeId` string, required
    - `projectId` string, required
    - `from` string, required
    - `to` string, required
    - `relation` 'contains' | 'derivedFrom' | 'describes' | 'sameEntity' | 'joinsOn' | 'timeAligned' | 'references' | 'answeredBy', required
    - `weight` number, required
    - `evidence` object[], required
    - `origin` 'derived' | 'observed' | 'corrected', required
    - `derivation` object, required
      - `version` string
  - `truncated` boolean

## Other responses

- `404`: Project or node absent or invisible

---

[API](https://skmtc.dev/cernion/apis/cernion-energy-tools-api.md) · [All operations](https://skmtc.dev/cernion/apis/cernion-energy-tools-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cernion/apis/cernion-energy-tools-api/revisions/cdb94473b538?raw)
