---
title: "Get object sub-tree"
method: GET
path: "/v1/objects/{object-id}/sub-tree"
tags: ["Objects"]
---

# Get object sub-tree

`GET /v1/objects/{object-id}/sub-tree`

Retrieve a recursively nested sub-tree of objects starting from the specified parent object. Each node carries its accessible children under a `children` property.

## Path parameters

- `object-id` integer, required — Parent object ID

## Query parameters

- `class` string — Optional comma-separated list of object class names. If provided, only objects of the listed classes (and ancestors that lead to them) are returned. Unknown class names are ignored.
- `maxDepth` integer — Maximum tree depth to traverse. Values above 100 are capped at 100.

## Response `200`

Object sub-tree retrieved successfully

- ObjectTreeNode[]
  - `alias` string — Object alias
  - `category` integer — Object category ID
  - `class` 'AccessPoint' | 'AgentPolicyLogParser' | 'Asset' | 'AssetGroup' | 'AssetRoot' | 'BusinessService' | 'BusinessServiceProto' | 'BusinessServiceRoot' | 'Chassis' | 'Cluster' | 'Condition' | 'Container' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Sensor' | 'ServiceCheck' | 'ServiceRoot' | 'Subnet' | 'Template' | 'TemplateGroup' | 'TemplateRoot' | 'VPNConnector' | 'Zone'
  - `guid` string, uuid — Object GUID
  - `id` integer — Object ID
  - `ipAddress` InetAddress
    - `family` integer — IP address family
    - `address` integer — IP address
    - `prefixLength` integer — IP address prefix length
  - `isInMaintenanceMode` boolean — true if object is in maintenance mode
  - `isMaintenanceApplicable` boolean — true if object can be placed into maintenance mode
  - `isMaintenanceScheduled` boolean — true if object has pending scheduled maintenance
  - `name` string — Object name
  - `timestamp` string, date-time — Object last change timestamp
  - `status` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
  - `children` ObjectTreeNode[] — Nested child objects (recursive)

## Other responses

- `401` — Unauthorized
- `403` — User does not have read access to given object
- `404` — Object with given ID does not exist

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/versions/ee1f54ee3abd/schema)