Skip to main content

Cookie control banner

Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.
Browse Documentation
HTTP - Delivery

Node

Created by Contensis product team, last modified by zengenti on 24 Feb 2022

A node represents a location within the navigational structure of a website. The linking of nodes as parent-child relationships forms the hierarchical structure of a website, with a node having a single parent and (optionally) multiple child nodes.

A single entry can be assigned to a node, separating the responsibility of navigation management from content editing.

Properties

NameData typeData formatDescription
idstringuuidThe node identifier as a 128 bit GUID
parentIdstringuuidThe identifier of the parent node as a 128 bit GUID
projectIdstringThe friendly name given to the project
displayNameobjectlocalized valueThe localised displayName of the node
slugobjectlocalized valueThe localised displayName of the node
childCountnumberThe count of child nodes
isCanonicalbooleanTrue if the node represents the canonical path for the associated entry; false otherwise
includeInMenubooleanTrue if the node should be included in menus; false otherwise. Defaults to true. Does not stop the node from being navigable
languagestringlanguageThe language that the node represents
pathstringURIThe path of the node
version.versionNostringThe version number of the node
EntryobjectentryThe entry associated with the node, if requested
childrenobject[...]nodeIf a depth is specified when requesting a node then the children field would include the descendant nodes to the specified depth

Example

JSON
{ "id": "3B9CCCD6-D0F9-4FA7-BE8F-62A3EDCCA2DD", "parentId": "EFD16C0D-DE03-4D29-B979-76E20F9F1642", "projectId": "movieDb", "slug": "last-action-hero", "displayName": "The Last Action Hero", "isCanonical": true, "language": "en-GB", "path": "/en-GB/movies/action/last-action-hero", "childCount": 10, "children": [], "entry": { "sys": { "id": "e6976206-a488-45e3-a438-244b871f48c0" } }, "version": { "versionNo": "1.0" }, "includeInMenu": true }