---
title: "GET /api/v1/docs-views/{spaceId}"
method: GET
path: "/api/v1/docs-views/{spaceId}"
---

# GET /api/v1/docs-views/{spaceId}

`GET /api/v1/docs-views/{spaceId}`

## 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/docs-views/{spaceId}`
- Auth: none declared

## Path parameters

- `spaceId` integer, required: Space id, from GET /spaces.

## Headers

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

## Response `200`

The Docs view tree, with file paths

- DocsView
  - `spaceId` integer, required
  - `rootNavItemId` integer, required: The Space root; reorder the top level with its children/order route.
  - `docsSite` boolean, required
  - `twoWaySync` boolean, required
  - `mirrorsFiles` boolean, required: Whether the Docs view follows the repo files: containers are directories, pages cannot hold pages, and nothing can be unlisted.
  - `data` DocsViewNode[], required
    - `navItemId` integer, required
    - `title` string, required
    - `type` 'container' | 'page', required
    - `documentId` string, nullable, required
    - `path` string, nullable, required: The page's file, or the container's directory, in the Files view; null when it has none.
    - `kind` 'group' | 'tab' | 'dropdown' | 'anchor' | 'link', nullable, required: How a container renders on the docs site; null for pages.
    - `config` object, nullable, required
      - `icon` string
      - `hidden` boolean
      - `href` string, uri
      - `access` 'public' | 'private'
    - `hidden` boolean, required
    - `access` 'public' | 'private', nullable, required: The container's own docs site access; null inherits.
    - `url` string, nullable, required: Where the published docs site serves the page; null when nothing is published.
    - `children` DocsViewNode[], required

## Other responses

- `400`: Bad request
- `403`: Permission is missing
- `404`: Space or item not found, or the Space has neither a docs site nor two-way sync

---

[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/7b303b7ddf6a?raw)