List items

GET /boards/{boardId}/items

Updated 16 Sep 20262 min read

GET/boards/{boardId}/itemsTry it

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

Request

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

const response = await fetch("https://api.mockflow.com/v1/boards/brd_3f9e2a/items", {
  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/items",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
)

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

Response

{
  "nextCursor": "string",
  "hasMore": false,
  "data": [
    {
      "id": "itm_k9",
      "type": "string",
      "componentType": "string",
      "boardId": "brd_3f9e2a",
      "sectionId": "string",
      "groupId": "string"
    }
  ]
}

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

Every item on the board in z-order, flat: sections contain items by position, which sectionId reports. Add include=data to get each item's decoded content.

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

Query parameters

typestringquery

Filter by item type. Comma separate several.

sectionIdstringquery

Only items inside this section, or none for items in no section.

groupIdstringquery

qstringquery

Substring match on item text.

includeenum<string>query

data to include each item's decoded content. One of data.

cursorstringquery

Opaque cursor from a previous response's nextCursor.

limitintegerquery

Defaults to 50.

Response

200 · application/json

nextCursorstring | null

hasMoreboolean

dataItem[]

Child attributes

idstring

typestring

An ItemType, or other for an editor widget the API has no type for.

componentTypestring

The editor's own class name, exact where type is a family.

boardIdstring

sectionIdstring | null

The section the item sits inside, by position.

groupIdstring | null

positionPoint

sizeSize

rotationnumber

zIndexinteger

lockedboolean

textstring

Plain text extracted from the item, for search and the outline.

readbackenum<string>

One of exact, unwrapped, text, pointer, parts or none.

dataItemData

Selected by the sibling type. One schema per item type, generated from the component registry.

fromstring | null

Connectors only: the item or group: the line starts at.

tostring | null

Connectors only.

directedboolean

Connectors only.

labelstring

Connectors only.

urlstring

Opens the board focused on this item.

Errors

429rate_limited

Too many requests.

Was this page helpful?