get /<uuid>/related

Get related

Endpoint returns all nodes directly connected to a given central node, as well as the relations between the central and outer nodes, regardless of type.

In the following example the id of the Center-node is used in the /<uuid>/related endpoint, which will return the following elements in the endpoint’s response:

  • the nodes Parent, Child, Outer 1 and Outer 2
  • both OWNS-relations
  • both RELATED-relations

As the get related endpoint returns all nodes and relations regardless of type, it means that it can be considered to be a superset of the get children and get parents endpoint. However, as this endpoint returns every element directly connected, the overall number of elements can be way higher.
Use the specialized get children and get parents endpoint in situations, where only the ownership relation is relevant.

Request

curl \
  -H 'Authorization: Bearer secret-token:PIPeJGUt7c00ENn8a5uDlc' \
  https://api.example.com/74a8fcd9-6cb0-4b0d-8d42-0b6c3c54d1ac/related
import requests


url = "https://api.example.com/74a8fcd9-6cb0-4b0d-8d42-0b6c3c54d1ac/related"


headers = {"Authorization": "Bearer secret-token:PIPeJGUt7c00ENn8a5uDlc"}


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


print(response.json())
const url = 'https://api.example.com/74a8fcd9-6cb0-4b0d-8d42-0b6c3c54d1ac/related';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer secret-token:PIPeJGUt7c00ENn8a5uDlc'}
};


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


$client = new \GuzzleHttp\Client();


$response = $client->request('GET', 'https://api.example.com/74a8fcd9-6cb0-4b0d-8d42-0b6c3c54d1ac/related', [
  'headers' => [
    'Authorization' => 'Bearer secret-token:PIPeJGUt7c00ENn8a5uDlc',
  ],
]);


echo $response->getBody();

Response

200 · OK

Center element found and returning its related elements in a collection response.

MDN HTTP.dev 

304 · Not Modified

Not modified. Returned when If-None-Match header matches current ETag.

MDN HTTP.dev 

401 · Unauthorized

The provided token is either invalid or expired.

MDN HTTP.dev 

404 · Not Found

Element does not exist, or the current user does not have permissions to access the element.

MDN HTTP.dev 

412 · Precondition Failed

Precondition failed. If-Match or If-None-Match condition not met.

MDN HTTP.dev 
{
  "type": "_PartialCollection",
  "id": "/45482998-274a-43d0-a466-f31d0b24cc0a/related",
  "totalNodes": 3,
  "links": {
    "first": "/45482998-274a-43d0-a466-f31d0b24cc0a/related",
    "previous": null,
    "next": null,
    "last": "/45482998-274a-43d0-a466-f31d0b24cc0a/related"
  },
  "nodes": [
    {
      "type": "Comment",
      "id": "251654a1-588e-4dc4-836f-b1e334d91aae",
      "data": {
        "created": "2025-09-27T10:39:51+00:00",
        "name": "Yellow",
        "updated": "2025-09-27T10:39:51+00:00",
        "content": "Yellow is the color between green and orange on the spectrum of light. It is evoked by light with a dominant wavelength of roughly 575–585 nm. It is a primary color in subtractive color systems, used in painting or color printing. In the RGB color model, used to create colors on television and computer screens, yellow is a secondary color made by combining red and green at equal intensity. Carotenoids give the characteristic yellow color to autumn leaves, corn, canaries, daffodils, and lemons, as well as egg yolks, buttercups, and bananas. They absorb light energy and protect plants from photo damage in some cases. Sunlight has a slight yellowish hue when the Sun is near the horizon, due to atmospheric scattering of shorter wavelengths (green, blue, and violet)."
      }
    },
    {
      "type": "Sphere",
      "id": "56fda20c-b238-4034-b555-1df47c47e17a",
      "data": {
        "created": "2025-09-27T10:39:51+00:00",
        "name": "Tag",
        "updated": "2025-09-27T10:39:51+00:00"
      }
    },
    {
      "type": "Comment",
      "id": "5bd2a18a-6d26-4fcd-99a7-9705794b63fc",
      "data": {
        "created": "2025-09-27T10:39:51+00:00",
        "name": "Additive color model",
        "updated": "2025-09-27T10:39:51+00:00",
        "content": "Additive color or additive mixing is a property of a color model that predicts the appearance of colors made by coincident component lights, i.e. the perceived color can be predicted by summing the numeric representations of the component colors. Modern formulations of Grassmann's laws describe the additivity in the color perception of light mixtures in terms of algebraic equations. Additive color predicts perception and not any sort of change in the photons of light themselves. These predictions are only applicable in the limited scope of color matching experiments where viewers match small patches of uniform color isolated against a grey or black background."
      }
    }
  ],
  "relations": [
    {
      "type": "HAS_TAG",
      "id": "39a3c287-89f1-494f-8d1d-725320ca2d1f",
      "start": "251654a1-588e-4dc4-836f-b1e334d91aae",
      "end": "45482998-274a-43d0-a466-f31d0b24cc0a",
      "data": {
        "created": "2025-09-27T10:39:58+00:00",
        "updated": "2025-09-27T10:39:58+00:00"
      }
    },
    {
      "type": "OWNS",
      "id": "bc1ba1ad-5866-4c23-a58e-15282994c72c",
      "start": "56fda20c-b238-4034-b555-1df47c47e17a",
      "end": "45482998-274a-43d0-a466-f31d0b24cc0a",
      "data": {
        "created": "2025-09-27T10:39:58+00:00",
        "updated": "2025-09-27T10:39:58+00:00"
      }
    },
    {
      "type": "HAS_TAG",
      "id": "e293d714-9dd3-4186-b0e5-c7531cf74baa",
      "start": "5bd2a18a-6d26-4fcd-99a7-9705794b63fc",
      "end": "45482998-274a-43d0-a466-f31d0b24cc0a",
      "data": {
        "created": "2025-09-27T10:39:58+00:00",
        "updated": "2025-09-27T10:39:58+00:00"
      }
    }
  ]
}
Access-Control-Allow-Headers: Authorization, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method
Access-Control-Allow-Methods: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: ETag, Location
Allow: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Cache-Control: no-cache, private
ETag: "YgbFC4u5EgC"
X-Powered-By: Ember Nexus API
{
  "type": "object",
  "required": [
    "type",
    "id",
    "totalNodes",
    "links",
    "nodes",
    "relations"
  ],
  "properties": {
    "type": {
      "type": "string",
      "enum": "_PartialCollection"
    },
    "id": {
      "type": "string",
      "description": "URL of the current collection page."
    },
    "totalNodes": {
      "type": "integer"
    },
    "links": {
      "type": "object",
      "required": [
        "first",
        "previous",
        "next",
        "last"
      ],
      "properties": {
        "first": {
          "type": "string",
          "description": "URL to the collection's first page."
        },
        "previous": {
          "type": "string",
          "description": "URL to the collection's previous page, relative to the current page.",
          "nullable": true
        },
        "next": {
          "type": "string",
          "description": "URL to the collection's next page, relative to the current page.",
          "nullable": true
        },
        "last": {
          "type": "string",
          "description": "URL to the collection's last page."
        }
      }
    },
    "nodes": {
      "type": "array",
      "items": {
        "type": "#/components/schemas/Element"
      }
    },
    "relations": {
      "type": "array",
      "items": {
        "type": "#/components/schemas/Element"
      }
    }
  }
}

response has no body

Access-Control-Allow-Headers: Authorization, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method
Access-Control-Allow-Methods: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: ETag, Location
Allow: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Cache-Control: no-cache, private
ETag: "YgbFC4u5EgC"
X-Powered-By: Ember Nexus API

no schema available

{
  "type": "https://api.example.com/error/401/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authorization for the request failed due to possible problems with the token (incorrect or expired), password (incorrect or changed), the user's unique identifier, or the user's status (e.g., missing, blocked, or deleted)."
}
Access-Control-Allow-Headers: Authorization, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method
Access-Control-Allow-Methods: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: ETag, Location
Allow: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Cache-Control: no-cache, private
X-Powered-By: Ember Nexus API
{
  "$schema": "https://spec.openapis.org/oas/3.0/schema/2021-09-28#/definitions/Schema",
  "type": "object",
  "description": "RFC 7807 Problem Details object.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "detail": {
      "type": "string"
    }
  }
}
{
  "type": "https://api.example.com/error/404/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "Requested element was not found."
}
Access-Control-Allow-Headers: Authorization, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method
Access-Control-Allow-Methods: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: ETag, Location
Allow: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Cache-Control: no-cache, private
X-Powered-By: Ember Nexus API
{
  "$schema": "https://spec.openapis.org/oas/3.0/schema/2021-09-28#/definitions/Schema",
  "type": "object",
  "description": "RFC 7807 Problem Details object.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "detail": {
      "type": "string"
    }
  }
}
{
  "type": "https://api.example.com/error/412/precondition-failed",
  "title": "Precondition Failed",
  "status": 412,
  "detail": "Precondition does not match."
}
Access-Control-Allow-Headers: Authorization, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method
Access-Control-Allow-Methods: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: ETag, Location
Allow: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Cache-Control: no-cache, private
X-Powered-By: Ember Nexus API
{
  "$schema": "https://spec.openapis.org/oas/3.0/schema/2021-09-28#/definitions/Schema",
  "type": "object",
  "description": "RFC 7807 Problem Details object.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "detail": {
      "type": "string"
    }
  }
}

Request Parameters

uuid

required

pathstringuuid

page

optional

queryintegerdefault 1≥ 1

Index of the page to be accessed. First page / index is 1.

Example: 1

Pagination tutorial 

pageSize

optional

queryintegerdefault 25≥ 1

Number of elements to be returned in a single page.

Example: 25

Pagination tutorial 

Request Header

Authorization

optional

Bearer token for user authentication. If omitted, the request is processed as an anonymous user; if provided, the associated user account is used.

MDN HTTP.dev Authentication guide 

If-Match

optional

Used primarily for optimistic concurrency control — the request is only executed if the resource's ETag matches the provided value.

MDN HTTP.dev Caching guide 

If-None-Match

optional

Used primarily for caching — skips re-downloading an unchanged resource by returning 304 Not Modified if the resource's ETag matches the provided value.

MDN HTTP.dev Caching guide 

Response Header

ETag

optional

Entity tag used for caching and optimistic concurrency control.

Note: ETag is not included for collections which are too big.

MDN HTTP.dev Caching guide 

Access-Control-Allow-Headers

always

Specifies which HTTP headers can be used during a cross-origin request, returned in preflight responses.

MDN HTTP.dev 

Access-Control-Allow-Methods

always

Indicates which HTTP methods are permitted for cross-origin requests, typically returned in preflight responses.

MDN HTTP.dev 

Access-Control-Allow-Origin

always

Specifies which origin(s) may access the resource.

MDN HTTP.dev 

Access-Control-Expose-Headers

always

Lists the response headers that browsers are allowed to access from JavaScript beyond the default restricted set.

MDN HTTP.dev 

Allow

always

Lists the HTTP methods supported by the endpoint; returned alongside a 405 Method Not Allowed response.

MDN HTTP.dev 

Cache-Control

always

Directives controlling caching behavior for the response.

MDN HTTP.dev 

X-Powered-By

always

Identifies the underlying API implementation.

MDN HTTP.dev