Get Navigation Outline

Retrieve the navigation structure that defines the portal menu, routes, and page layout.

GET /api/public/outlines/navigation

Get Navigation Outline

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/public/outlines/navigation \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/outlines/navigation"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/public/outlines/navigation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "Json": "<string>",
  "401 Unauthorized": {}
}

Get Navigation Outline

Returns the navigation outline that defines the portal’s top-level menu structure, sidebar navigation, and page hierarchy. Operators customise this outline in the Nexudus dashboard. The portal renders its navigation tree directly from this response, making it the single source of truth for what menu items and pages are visible.

Authentication

Requires a valid customer bearer token.

Response

Returns an object with a single Json property containing the navigation structure as a serialised JSON string. Consumers must JSON.parse() the value to get the navigation tree.

Json · string

Serialised JSON string containing the navigation tree structure. Parse this to get the navigation items, routes, and page hierarchy.

Example Response

{
  "Json": "{\"Items\":[{\"Name\":\"Dashboard\",\"Url\":\"/\",\"Icon\":\"home\"}]}"
}

TypeScript Integration

import endpoints from '@/api/endpoints'
import { useData } from '@/api/fetchData'

const { resource: navResource } = useData<{ Json: string }>(httpClient, endpoints.system.outlines.navigation)
const navigation = JSON.parse(navResource.Json) // -> NavigationConfig

Usage in Portal

Context	Source file
Portal sidebar / top navigation	src/layouts/DefaultLayout.tsx
Route generation	src/routes/

Error Responses

401 Unauthorized · error

The bearer token is missing, expired, or invalid.

Related Endpoints

Method	Endpoint	Description
GET	/api/public/outlines/all	Get all system outlines
GET	/api/public/outlines/custom	Get custom outlines created by the operator
GET	/api/public/outlines/custom/published	Get published custom outlines
GET	/api/public/configuration	Get portal feature configuration