Get an item

GET /boards/{boardId}/items/{itemId}

Updated 16 Sep 20262 min read

GET/boards/{boardId}/items/{itemId}Try it

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

Request

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

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

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

Response

{
  "id": "itm_k9",
  "type": "string",
  "componentType": "string",
  "boardId": "brd_3f9e2a",
  "sectionId": "string",
  "groupId": "string"
}

{
  "error": {
    "code": "not_found",
    "message": "The resource does not exist or the token cannot see it.",
    "docsUrl": "https://mockflow.com/developers/concepts/errors#not_found"
  },
  "requestId": "req_45d49816999bac40"
}

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

Geometry, where it sits, and data decoded per the type's readback.

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

itemIdstringpathrequired

Response

200 · application/json

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

Child attributes

xnumberrequired

ynumberrequired

sizeSize

Child attributes

widthnumber

heightnumber

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

404not_found

The resource does not exist or the token cannot see it.

429rate_limited

Too many requests.

Was this page helpful?