1. Docs
  2. API Reference
  3. Get direct children of a node

Get direct children of a node

GET/api/v1/nodes/{id}/children

Returns the direct children of a node as an items array (one level only, not the full subtree), scoped to the current Environment. The node must be within the caller's accessible scope, otherwise 403 is returned.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Path Parameters

idstring Required

Responses

application/json

  • itemsNodeResponseDto[]*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

NodeResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/nodes/value/children" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "items": [
    {
      "id": "string",
      "application_id": "string",
      "parent_node_id": "string",
      "node_type": "string",
      "name": "string",
      "description": "string",
      "slug": "string",
      "status": "string",
      "metadata": {},
      "created_at": "2026-04-20T12:00:00.000Z",
      "updated_at": "2026-04-20T12:00:00.000Z",
      "version": 0
    }
  ]
}
 Related endpoints
GETList hierarchy (scoped tree)
POSTCreate a hierarchy node
GETList the hierarchy as parent edges
GETGet a hierarchy node
PATCHUpdate a hierarchy node
DELETEDelete a hierarchy node
GETGet subtree from a node
GETGet ancestor chain for a node
POSTMove (reparent) a node
GETList identities at a node
GETGet identity summary for a node
 Was this page helpful?

Tell us how we can improve this guide.

Canopy