> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cloudraker.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server.

# Walk the org-wide graph outward from an entity

GET https://api.cloudraker.com/ontology/entities/{entityId}/related

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.

Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/ontology/get-org-ontology-related-entities

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: CloudRaker API
  version: 1.0.0
paths:
  /ontology/entities/{entityId}/related:
    get:
      operationId: get-org-ontology-related-entities
      summary: Walk the org-wide graph outward from an entity
      description: >-
        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.
      tags:
        - ontology
      parameters:
        - name: entityId
          in: path
          required: true
          schema:
            type: string
        - name: depth
          in: query
          description: Hops to walk, 1–3. Defaults to 1.
          required: false
          schema:
            type: integer
            default: 1
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Neighbouring entities and the connecting edges.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OntologyRelatedEntities'
servers:
  - url: https://api.cloudraker.com
    description: Production
  - url: https://api.staging.raker.one
    description: Staging
  - url: https://api.dev.raker.one
    description: Development
components:
  schemas:
    OntologyRelatedEntitiesEntitiesItems:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        name:
          type: string
        distance:
          type: integer
          description: Hops from the seed entity.
      required:
        - id
        - type
        - name
        - distance
      title: OntologyRelatedEntitiesEntitiesItems
    GraphEdge:
      type: object
      properties:
        sourceId:
          type: string
        targetId:
          type: string
        relation:
          type: string
        fileId:
          type: string
          description: The file the relation was observed in.
      required:
        - sourceId
        - targetId
        - relation
        - fileId
      title: GraphEdge
    OntologyRelatedEntities:
      type: object
      properties:
        entities:
          type: array
          items:
            $ref: '#/components/schemas/OntologyRelatedEntitiesEntitiesItems'
        edges:
          type: array
          items:
            $ref: '#/components/schemas/GraphEdge'
      required:
        - entities
        - edges
      title: OntologyRelatedEntities
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "entities": [
    {
      "id": "org-12345",
      "type": "organization",
      "name": "Acme Corporation",
      "distance": 1
    },
    {
      "id": "user-67890",
      "type": "user",
      "name": "Jane Doe",
      "distance": 1
    },
    {
      "id": "project-54321",
      "type": "project",
      "name": "Project Phoenix",
      "distance": 2
    }
  ],
  "edges": [
    {
      "sourceId": "user-67890",
      "targetId": "org-12345",
      "relation": "employed_by",
      "fileId": "file-98765"
    },
    {
      "sourceId": "project-54321",
      "targetId": "org-12345",
      "relation": "owned_by",
      "fileId": "file-87654"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/ontology/entities/entityId/related"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/ontology/entities/entityId/related';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudraker.com/ontology/entities/entityId/related"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.cloudraker.com/ontology/entities/entityId/related")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.cloudraker.com/ontology/entities/entityId/related")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.cloudraker.com/ontology/entities/entityId/related', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/ontology/entities/entityId/related");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/ontology/entities/entityId/related")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```