---
title: "The board as text"
method: GET
path: "/boards/{boardId}/outline"
tags: ["Boards"]
---

# The board as text

`GET /boards/{boardId}/outline`

## Request

- Base URL: `https://api.mockflow.com/v1`
- URL: `https://api.mockflow.com/v1/boards/{boardId}/outline`
- Auth: HTTP bearer

The board the way the product's own board scan reads it: sections with the items inside them
in reading order, standalone items, and the connections between items. Every line carries the
item id the Items endpoints take. JSON, or Markdown with `Accept: text/markdown`.

## Response `200`

The outline.

- Outline
  - `boardId` string
  - `title` string
  - `counts` object
  - `sections` object[]
    - `id` string
    - `title` string
    - `counts` object
    - `items` OutlineNode[]
      - `id` string
      - `type` string
      - `title` string
      - `text` string
  - `standalone` OutlineNode[]
    - `id` string
    - `type` string
    - `title` string
    - `text` string
  - `connections` object[]
    - `id` string
    - `from` string, nullable
    - `to` string, nullable
    - `label` string
    - `directed` boolean

## Other responses

- `429`: Too many requests.
- `4XX`: An error. See the envelope and the code list on the Errors page.

---

[API](https://skmtc.dev/mockflow/apis/mockflow-boards-api.md) - [All operations](https://skmtc.dev/mockflow/apis/mockflow-boards-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mockflow/apis/mockflow-boards-api/revisions/1a890390518c?raw)