ListNodesOptions

GET /nodes. Every option is optional: with none of them, the request is the whole tree of the site the request Host maps to.

Extends

• RequestOptions

Properties

from?

optional from?: string

The anchor: a node Guid or a published path (/blog/second). Defaults to the site root.

---

host?

optional host?: string

The hostname a localeHost site serves, for a path-shaped from — see PathOptions.host.

---

include?

optional include?: readonly NavigationInclude[]

Defaults to ['self', 'descendants'] server-side — a bare call is the whole site tree.

---

locale?

optional locale?: string

Refused when from is a path under a site with a locale addressing strategy (400 locale_not_addressable) — the path’s own prefix or host says the locale.

---

maxDepth?

optional maxDepth?: number

Bounds descendants by absolute depth from the site root — the same scale NavigationNode.depth reports.

---

signal?

optional signal?: AbortSignal

Inherited from

RequestOptions.signal

---

site?

optional site?: string

Site root node id, from listSites. Omitted, the server infers it from the request Host.