The board's structure

GET /boards/{boardId}/structure

Updated 17 Sep 20262 min read

GET/boards/{boardId}/structureTry it

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

Request

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

const response = await fetch("https://api.mockflow.com/v1/boards/brd_3f9e2a/structure", {
  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/structure",
    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",
      "position": {
        "x": 0,
        "y": 0
      },
      "size": {
        "width": 0,
        "height": 0
      },
      "counts": {},
      "children": [
        {
          "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"
    }
  ],
  "groups": [
    {
      "id": "string",
      "itemIds": [
        "string"
      ]
    }
  ]
}

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

The machine view behind the outline. Sections by geometry with their items and per-type counts, groups, and connector edges with labels.

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

positionPoint

sizeSize

countsobject

childrenOutlineNode[]

standaloneOutlineNode[]

Child attributes

idstring

typestring

titlestring

textstring

groupsobject[]

Child attributes

idstring

itemIdsstring[]

edgesobject[]

Child attributes

idstring

fromstring | null

tostring | null

fromTitlestring | null

toTitlestring | null

directedboolean

labelstring

Errors

429rate_limited

Too many requests.

Was this page helpful?