> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Navigation Outline

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

# 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.

<ResponseField name="Json" type="string">
  Serialised JSON string containing the navigation tree structure. Parse this to get the navigation items, routes, and page hierarchy.
</ResponseField>

## Example Response

```json theme={null}
{
  "Json": "{\"Items\":[{\"Name\":\"Dashboard\",\"Url\":\"/\",\"Icon\":\"home\"}]}"
}
```

## TypeScript Integration

```typescript theme={null}
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

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

## 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            |