List assets as a hierarchy

List assets in your organization with their hierarchy details. Each asset includes its parent, its depth in the hierarchy, and how many descendants it has.

By default, the API returns one level of the hierarchy. Set include_all_descendants to true to return child assets at every level. Each asset's hierarchy_metadata lists its ancestors, from the root down.

This endpoint accepts the same filters and sorting options as List assets. Use the parent_id filter to list the immediate children of a specific asset.

📘

The number of hierarchy levels depends on your plan. Premium allows 2 levels (a parent and its children). Enterprise allows up to 10 levels.

Requirements

📘

If your organization uses site-based access for assets, the API only returns assets that the API token's user can access through their site membership.

Body Params

The parameters for ListAssetsHierarchy

The parameters for ListAssetsHierarchy

string

OPTIONAL. The value of next_page_token from a previous response. If
specified, the API will return the next batch of results following the
previous list assets hierarchy request.

int32

OPTIONAL. The number of assets to return. By default, each request
returns 50 assets. You can specify a page_size value between 1 to 100.

OPTIONAL. Keywords to search for. Matches Asset ID, type name, and display name.

asset_filters
array of objects

OPTIONAL. Asset filters to apply, up to 20.

asset_filters
order_by
object

OPTIONAL. Sort order. Defaults to code.

boolean

OPTIONAL. When true, expands the whole subtree instead of one level.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json