Get the navigation tree

GEThttps://example.com/api/v1/nav.json

Returns the navigation groups and their links. The href value is relative to your site URL, and the url value is absolute. A link with nested pages also has a children array of links.

Responses

200

Navigation groups and their links

Content type: application/json

groupsarray<object>Required
Show Child Attributes
- titlestringRequired
- hrefstringRequired
- urlstring (uri)Required
- itemsarray<object>Required
  Show Child Attributes
  - titlestringRequired
  - hrefstringRequired
  - urlstring (uri)Required
  - childrenarray<NavLink>

{
  "groups": [
    {
      "title": "Get Started",
      "href": "/",
      "url": "https://example.com/",
      "items": [
        {
          "title": "Quickstart",
          "href": "/quickstart",
          "url": "https://example.com/quickstart",
          "children": [
            {}
          ]
        }
      ]
    }
  ]
}

Code samples

curl --request GET \
  --url 'https://example.com/api/v1/nav.json'