Skip to main content
GET
/
api
/
public
/
outlines
/
navigation
{
  "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

ContextSource file
Portal sidebar / top navigationsrc/layouts/DefaultLayout.tsx
Route generationsrc/routes/

​
Error Responses

​
401 Unauthorized
error
The bearer token is missing, expired, or invalid.
MethodEndpointDescription
GET/api/public/outlines/allGet all system outlines
GET/api/public/outlines/customGet custom outlines created by the operator
GET/api/public/outlines/custom/publishedGet published custom outlines
GET/api/public/configurationGet portal feature configuration