---
title: "GET /api/v1/nav/tree"
method: GET
path: "/api/v1/nav/tree"
---

# GET /api/v1/nav/tree

`GET /api/v1/nav/tree`

## Request

- Base URL: `https://falconer.com` (the document declares no server; this is the origin it was published from)
- URL: `https://falconer.com/api/v1/nav/tree`
- Auth: none declared

## Query parameters

- `section` 'company' | 'private': Where the document landed. Without a parent it lands in your private section.
- `parentFolderId` integer: Parent folder or document nav item ID. Omit for the section root.
- `parentDocumentId` string: Parent document UUID.
- `spaceId` integer: Read from this Space's root. Pass instead of parentFolderId or parentDocumentId.
- `depth` integer
- `maxNodes` integer

## Headers

- `x-organization-id` string: Required when using OAuth bearer tokens.

## Response `200`

Visible nav tree for a section, folder, or document

- NavTreeResponse
  - `data` NavItem[], required
    - `type` 'folder' | 'document' | 'file', required
    - `navItemId` number, required
    - `parentFolderId` number, nullable, required: Parent folder or document nav item ID; null at the section root.
    - `title` string, required
    - `icon` string, nullable, required
    - `order` number, required
    - `section` 'company' | 'private', required: Where the document landed. Without a parent it lands in your private section.
    - `folderId` number
    - `description` string, nullable
    - `childCount` number: Visible direct children of a folder or document.
    - `childrenLoaded` boolean: Whether all visible direct children have been loaded.
    - `document` NavDocument
      - `id` string, required: Document UUID
      - `title` string, required
      - `url` string, required
      - `visibility` 'private' | 'shared', required
      - `updatedAt` string, required
    - `file` NavFile
      - `id` string, required: Library file id
      - `filename` string, required
      - `mimeType` string, required
      - `size` number, required
      - `updatedAt` string, required
    - `children` NavItem[]: Nested nav items when returned by tree endpoints.
  - `truncated` boolean, required

## Other responses

- `400`: Bad request
- `404`: Folder not found
- `409`: Parent document has multiple nav placements

---

[API](https://skmtc.dev/falconer/apis/falconer-public-api.md) · [All operations](https://skmtc.dev/falconer/apis/falconer-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/falconer/apis/falconer-public-api/revisions/c00420511526?raw)