# The board as text

> GET /boards/{boardId}/outline

Source: https://mockflow.com/developers/reference/boards/get-board-outline

**GET** `https://api.mockflow.com/v1/boards/{boardId}/outline`  
Scopes: `boards:read`

**curl**

```bash
curl https://api.mockflow.com/v1/boards/brd_3f9e2a/outline \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY"
```

**JavaScript**

```javascript
const response = await fetch("https://api.mockflow.com/v1/boards/brd_3f9e2a/outline", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`
  }
});

const data = await response.json();
```

**Python**

```python
import os, requests

response = requests.get(
    "https://api.mockflow.com/v1/boards/brd_3f9e2a/outline",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
)

response.raise_for_status()
data = response.json()
```

**200**

```json
{
  "boardId": "brd_3f9e2a",
  "title": "Q4 Launch Planning",
  "counts": {},
  "sections": [
    {
      "id": "string",
      "title": "Q4 Launch Planning",
      "counts": {},
      "items": [
        {
          "id": "string",
          "type": "string",
          "title": "Q4 Launch Planning",
          "text": "Interview 5 users"
        }
      ]
    }
  ],
  "standalone": [
    {
      "id": "string",
      "type": "string",
      "title": "Q4 Launch Planning",
      "text": "Interview 5 users"
    }
  ],
  "connections": [
    {
      "id": "string",
      "from": "string",
      "to": "string",
      "label": "string",
      "directed": false
    }
  ]
}
```

**429**

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "docsUrl": "https://mockflow.com/developers/concepts/errors#rate_limited"
  },
  "requestId": "req_45d49816999bac40"
}
```

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

### Authorization

- `Authorization` (string, required): `Bearer <key>`. The key needs `boards:read` scope. Create and manage keys in the [developer console](/developers/console/); what each scope unlocks is on the [scopes page](/developers/concepts/scopes).

### Path parameters

- `boardId` (string, required)

### Response

- `boardId` (string)
- `title` (string)
- `counts` (object)
- `sections` (object[]): - `id` (string)
  - `title` (string)
  - `counts` (object)
  - `items` (OutlineNode[])
- `standalone` (OutlineNode[]): - `id` (string)
  - `type` (string)
  - `title` (string)
  - `text` (string)
- `connections` (object[]): - `id` (string)
  - `from` (string | null)
  - `to` (string | null)
  - `label` (string)
  - `directed` (boolean)

### Errors

- 429 `rate_limited`: Too many requests.