The board as text

GET /boards/{boardId}/outline

Updated 17 Sep 20262 min read

GET/boards/{boardId}/outlineTry it

Basehttps://api.mockflow.com/v1Scopesboards:read

Request

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

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();

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()

Response

{
  "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
    }
  ]
}

{
  "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

Authorizationstringheaderrequired

Bearer <key>. The key needs boards:read scope. Create and manage keys in the developer console; what each scope unlocks is on the scopes page.

Path parameters

boardIdstringpathrequired

Response

200 · application/json

boardIdstring

titlestring

countsobject

sectionsobject[]

Child attributes

idstring

titlestring

countsobject

itemsOutlineNode[]

standaloneOutlineNode[]

Child attributes

idstring

typestring

titlestring

textstring

connectionsobject[]

Child attributes

idstring

fromstring | null

tostring | null

labelstring

directedboolean

Errors

429rate_limited

Too many requests.

Was this page helpful?