get_tree_details

Read a navigation tree's whole branch structure. Branches aren't nodes, so no other tool reaches them — list_trees only tells you how many there are. For each branch, nested as deep as it goes, you get its id, title, lead text, what seeds it, any elements attached by hand, how it expands along relationships, how it's ordered, its child branches, and the elements it currently holds.

Call this before update_tree. Setting a tree's branches replaces the whole structure, so read it here, change what you need and send it back — keeping each branch's id preserves its identity and any links to its published page. The list of elements a branch currently holds is worked out on the fly and is ignored if you send it back.

A branch with a title is also a page in any publication using the tree, and its id is that page's id — which is how you find or link to it.

One caution with locale: asking for a language gives you translated titles and lead text. Don't send those back to update_tree — it always writes the model's default language, so you would overwrite the original wording with its translation. Read without a locale when you intend to write back.

{"tree": "Reading Order"}

{"tree": {"id": "c017...", "name": "Reading Order"}, "branches": [{"id": "br-1", "label": "Capabilities", "description": "What the platform does", "children": [], "nodes": [{"id": "9f0c...", "label": "Payment Capture"}]}]}