Flexible Hierarchy Snapshot Response

Output representation of the captured structure of a flexible hierarchy snapshot, lazily loaded one context node at a time.

JSON Example 

1{
2  "contextNode": {
3    "id": "0HNxx0000004N02EAM",
4    "predecessorNodeId": "0HNxx0000004N01EAM",
5    "referenceRecordId": "001xx000003GZ40AAG",
6    "referenceRecordType": "Account",
7    "referenceRecordTypeLabel": "Account",
8    "role": "Region",
9    "totalChildrenCount": 4,
10    "displayValues": [
11      {
12        "fieldName": "Name",
13        "fieldLabel": "Account Name",
14        "fieldType": "String",
15        "fieldValue": "EMEA Region",
16        "isLookup": false,
17        "isNameField": true
18      }
19    ],
20    "summaryValues": []
21  },
22  "ancestorNodes": [
23    {
24      "id": "0HNxx0000004N01EAM",
25      "referenceRecordId": "001xx000003GZ39AAG",
26      "referenceRecordType": "Account",
27      "referenceRecordTypeLabel": "Account",
28      "role": "Root",
29      "totalChildrenCount": 2,
30      "displayValues": [],
31      "summaryValues": []
32    }
33  ],
34  "ancestorRelations": [
35    {
36      "id": "0HRxx0000004R01EAM",
37      "predecessorNodeId": "0HNxx0000004N01EAM",
38      "successorNodeId": "0HNxx0000004N02EAM",
39      "displayValues": []
40    }
41  ],
42  "childNodes": [
43    {
44      "id": "0HNxx0000004N03EAM",
45      "predecessorNodeId": "0HNxx0000004N02EAM",
46      "referenceRecordId": "001xx000003GZ41AAG",
47      "referenceRecordType": "Account",
48      "referenceRecordTypeLabel": "Account",
49      "role": "Country",
50      "totalChildrenCount": 0,
51      "displayValues": [],
52      "summaryValues": []
53    }
54  ],
55  "childRelations": [
56    {
57      "id": "0HRxx0000004R02EAM",
58      "predecessorNodeId": "0HNxx0000004N02EAM",
59      "successorNodeId": "0HNxx0000004N03EAM",
60      "displayValues": []
61    }
62  ],
63  "pathToRoot": [
64    "0HNxx0000004N02EAM",
65    "0HNxx0000004N01EAM"
66  ],
67  "pagination": {
68    "hasNext": false,
69    "offset": 0,
70    "pageSize": 1000,
71    "totalChildNodes": 4
72  },
73  "hierarchyConfiguration": {
74    "id": "0RGDxx0000004GD1EAM",
75    "relationshipGraphDefinitionVersion": "1",
76    "entityDisplayFields": [
77      {
78        "entityName": "Account",
79        "entityLabel": "Account",
80        "graphViewFields": [
81          "Name"
82        ],
83        "gridViewFields": [
84          "Name"
85        ]
86      }
87    ],
88    "relationshipList": [
89      {
90        "parentNodeEntityApiName": "Account",
91        "childNodeEntityApiName": "Account"
92      }
93    ],
94    "summaryRollupList": []
95  },
96  "snapshotMetadata": {
97    "hierarchyId": "0H1xx0000004FH1EAM",
98    "capturedAt": "2026-07-20T08:27:26.000Z",
99    "locale": "en_US",
100    "navigationPolicy": "Standard",
101    "schemaVersion": 1,
102    "totalNodes": 16,
103    "totalRelationshipCount": 15,
104    "captureContext": {
105      "accessModel": "reResolveInUserContext",
106      "runAsIntegrationUser": false
107    }
108  },
109  "responseStatus": {
110    "statusCode": 200,
111    "message": "Snapshot retrieved."
112  }
113}

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
ancestorNodesFlexible Hierarchy Snapshot Node Details[]Context node’s ancestor nodes, ordered from the immediate parent up to the root.Big, 68.068.0
ancestorRelationsFlexible Hierarchy Snapshot Relationship Details[]Parent-child connections along the ancestor chain.Big, 68.068.0
childNodesFlexible Hierarchy Snapshot Node Details[]Paginated list of the context node’s direct children.Big, 68.068.0
childRelationsFlexible Hierarchy Snapshot Relationship Details[]Parent-child connections from the context node to the returned child nodes.Big, 68.068.0
contextNodeFlexible Hierarchy Snapshot Node DetailsNode that’s specified in the request. This is the node identified by nodeId, or the snapshot’s root node when nodeId isn’t specified.Big, 68.068.0
hierarchyConfigurationFlexible Hierarchy Snapshot Hierarchy Configuration DetailsFrozen configuration for the snapshot, including entity display fields, relationships, and rollup definitions.Big, 68.068.0
paginationFlexible Hierarchy Pagination DetailsPagination details for the childNodes array.Big, 68.068.0
pathToRootString[]Node IDs from the context node up to the root, inclusive, ordered with the context node first.Big, 68.068.0
responseStatusFlexible Hierarchy StatusHTTP status code and message for the API request.Big, 68.068.0
snapshotMetadataFlexible Hierarchy Snapshot Metadata DetailsMetadata about the snapshot, including capture time, schema version, and provenance.Big, 68.068.0