One item type, with its schema and an example

GET /item-types/{type}

Updated 16 Sep 20261 min read

GET/item-types/{type}Try it

Basehttps://api.mockflow.com/v1

Request

curl https://api.mockflow.com/v1/item-types/artifact \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY"

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

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

Response

{
  "type": "artifact",
  "label": "string",
  "hint": "string",
  "primitive": false,
  "creatable": false,
  "mcpTool": "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"
}

The JSON schema for that type's data, exactly what POST /boards/{boardId}/items validates against, plus an example payload and the types it can be converted to.

Authorization

Authorizationstringheaderrequired

Bearer <key>. Any key of the workspace. Create and manage keys in the developer console; what each scope unlocks is on the scopes page.

Path parameters

typeenum<string>pathrequired

Response

200 · application/json

typeenum<string>

Item types, generated from the MockFlow component registry. Primitive types are drawn by the editor; frame types are rich components whose data schema is the same one the MCP render_* tool accepts.

labelstring | null

hintstring | null

primitiveboolean

creatableboolean

mcpToolstring | null

readbackenum<string>

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

schemaRefstring

convertibleToenum<string>[]

schemaobject

exampleobject

docsUrlstring

Errors

404not_found

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

429rate_limited

Too many requests.

Was this page helpful?