---
title: "Get document outline"
method: GET
path: "/projects/{id}/outline/{path}"
---

# Get document outline

`GET /projects/{id}/outline/{path}`

## Path parameters

- `id` string, required
- `path` string, required

## Response `200`

Document outline

- DocumentOutline
  - `path` string, required
  - `document_symbols` DocumentSymbol[], required
    - `name` string, required
    - `detail` string
    - `kind` string, required
    - `range` Range, required
      - `start` Position, required
        - `line` integer, required
        - `character` integer, required
      - `end` Position, required
        - `line` integer, required
        - `character` integer, required
    - `children` DocumentSymbol[]

## Other responses

- `400` — Invalid request
- `404` — Project or file not found
- `500` — Internal server error

---

[API](https://skmtc.dev/hide-org/apis/hide-api.md) · [All operations](https://skmtc.dev/hide-org/apis/hide-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hide-org/hide-api/revisions/615b2b2a65a4/schema)