Get hierarchy paths for an object

Learn more about how to use the Get hierarchy path API to return all paths from an object to each root in a hierarchy instance.

Use the Get Hierarchy Path View to retrieve all available paths from an object to each root in a hierarchy instance. Use this API when an object can be reached through multiple parent branches. The response returns one path for each available branch. For example, if object F belongs to a hierarchy where it is connected through A > B > F, D > B > F, and E > C > F, the response returns all three root paths. This helps you identify every available route from the selected object to a root, which is especially useful in multiparent hierarchies.

This operation requires the MDM.Data.Hierarchy permission with the READ privilege.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request:

GET https://<environment>.reltio.com/reltio/api/{tenantId}/hierarchies/{instanceId}/objects/{entityId}/pathView

Request headers

The following request headers must be included.


Header	Value	Required
`Authorization`	`Bearer <token>`	Yes

Query parameters

The following table describes the query parameters and their values.


Parameter	Type	Required	Description	Accepted values / Default
`date`	String	No	Returns the hierarchy state for a specific date. Use ISO 8601 date format.	Example: `2025-10-10`. Default: today

Request body

This operation does not require a request body.

Example request

Use the following example to see how a complete request is structured with headers.

GET /{instanceId}/objects/{entityId}/pathView?date=2025-10-10
Authorization: Bearer <token>

Response fields

The following table describes the fields returned in the response body.


Field	Type	Description
`entityId`	String	The entity ID of the object.
`entityType`	String	The entity type of the object.
`label`	String	The label value of the object.
`hasMoreChildren`	Boolean	Indicates whether the object has more children than are returned in the `children` field.
`hasManyParents`	Boolean	Optional. Indicates whether the object has multiple parents. Default: `false`.
`cyclic`	Boolean	Optional. Indicates whether the object creates a cycle with any lower level in the hierarchy. Default: `false`.
`selected`	Boolean	Optional. Indicates whether this is the object specified in the request. Default: `false`.
`connectionId`	String	The connection ID between the object and its parent. For the root object, this value is `null`.
`children`	Array of objects	The list of child nodes. Each child repeats the same response structure recursively.

Example response

The following example shows the response body.

[
  {
    "entityId": "idRoot1",
    "entityType": "configuration/entityTypes/HCP",
    "label": "Root1",
    "hasMoreChildren": false,
    "children": [...]
  },
  {
    "entityId": "idRoot2",
    "entityType": "configuration/entityTypes/HCP",
    "label": "Root2",
    "hasMoreChildren": false,
    "children": [...]
  },
  {
    "entityId": "idRoot3",
    "entityType": "configuration/entityTypes/HCP",
    "label": "Root3",
    "hasMoreChildren": false,
    "children": [...]
  }
]

Unify and manage your data