get /<uuid>/children

Get children

Endpoint returns all children of a given parent element, as well as the OWNS-relations between the child nodes and the parent node.

In the following example, the response would include the nodes Child 1 and Child 2, as well as the two OWNS-relations, when the id of the Parent-node is used in the /<uuid>/children endpoint:

The inverse operation is the GET /<uuid>/parents endpoint.

Request

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


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


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/children';
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/children', [
  'headers' => [
    'Authorization' => 'Bearer secret-token:PIPeJGUt7c00ENn8a5uDlc',
  ],
]);


echo $response->getBody();

Response

200 · OK

Parent element found and returning its children 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": "/56fda20c-b238-4034-b555-1df47c47e17a/children",
  "totalNodes": 6,
  "links": {
    "first": "/56fda20c-b238-4034-b555-1df47c47e17a/children",
    "previous": null,
    "next": null,
    "last": "/56fda20c-b238-4034-b555-1df47c47e17a/children"
  },
  "nodes": [
    {
      "type": "Tag",
      "id": "45482998-274a-43d0-a466-f31d0b24cc0a",
      "data": {
        "created": "2025-09-27T10:39:51+00:00",
        "name": "Yellow",
        "updated": "2025-09-27T10:39:51+00:00",
        "color": "#FFC835"
      }
    },
    {
      "type": "Tag",
      "id": "6b8341ca-851a-4e98-8194-e57b87d30519",
      "data": {
        "created": "2025-09-27T10:39:51+00:00",
        "name": "Red",
        "updated": "2025-09-27T10:39:51+00:00",
        "color": "#BD002A"
      }
    },
    {
      "type": "Tag",
      "id": "6d1ccab4-559b-4086-92ac-370e30e40946",
      "data": {
        "created": "2025-09-27T10:39:51+00:00",
        "name": "Magenta",
        "updated": "2025-09-27T10:39:51+00:00",
        "color": "#ff00ff"
      }
    },
    {
      "type": "Tag",
      "id": "9f69f280-68ec-4dac-9ff3-c5608562060f",
      "data": {
        "created": "2025-09-27T10:39:51+00:00",
        "name": "Cyan",
        "updated": "2025-09-27T10:39:51+00:00",
        "color": "#00ffff"
      }
    },
    {
      "type": "Tag",
      "id": "aee9e678-42fa-48cf-85e3-33638bebf0b1",
      "data": {
        "created": "2025-09-27T10:39:51+00:00",
        "name": "Green",
        "updated": "2025-09-27T10:39:51+00:00",
        "color": "#006D23"
      }
    },
    {
      "type": "Tag",
      "id": "ce8abdea-2e6c-41d4-b779-87b803f77836",
      "data": {
        "created": "2025-09-27T10:39:51+00:00",
        "name": "Blue",
        "updated": "2025-09-27T10:39:51+00:00",
        "color": "#0059C8"
      }
    }
  ],
  "relations": [
    {
      "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": "OWNS",
      "id": "94ab04d8-c7a0-408c-aea7-59c66018b242",
      "start": "56fda20c-b238-4034-b555-1df47c47e17a",
      "end": "6b8341ca-851a-4e98-8194-e57b87d30519",
      "data": {
        "created": "2025-09-27T10:39:58+00:00",
        "updated": "2025-09-27T10:39:58+00:00"
      }
    },
    {
      "type": "OWNS",
      "id": "feb5bd9b-32e7-43f2-8b7e-9f6b7f0a0390",
      "start": "56fda20c-b238-4034-b555-1df47c47e17a",
      "end": "6d1ccab4-559b-4086-92ac-370e30e40946",
      "data": {
        "created": "2025-09-27T10:39:58+00:00",
        "updated": "2025-09-27T10:39:58+00:00"
      }
    },
    {
      "type": "OWNS",
      "id": "284d2787-9cae-42e4-98bb-aff84dcbfef8",
      "start": "56fda20c-b238-4034-b555-1df47c47e17a",
      "end": "9f69f280-68ec-4dac-9ff3-c5608562060f",
      "data": {
        "created": "2025-09-27T10:39:58+00:00",
        "updated": "2025-09-27T10:39:58+00:00"
      }
    },
    {
      "type": "OWNS",
      "id": "ca8266a9-4864-4ab7-9a9e-64a454af4a7d",
      "start": "56fda20c-b238-4034-b555-1df47c47e17a",
      "end": "aee9e678-42fa-48cf-85e3-33638bebf0b1",
      "data": {
        "created": "2025-09-27T10:39:58+00:00",
        "updated": "2025-09-27T10:39:58+00:00"
      }
    },
    {
      "type": "OWNS",
      "id": "eb5d2879-c5e6-43a6-b8ce-2a1188ca7073",
      "start": "56fda20c-b238-4034-b555-1df47c47e17a",
      "end": "ce8abdea-2e6c-41d4-b779-87b803f77836",
      "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

Id of the parent node. Response contains its children.

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