List boards

GET /boards

Updated 16 Sep 20262 min read

GET/boardsTry it

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

Request

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

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

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

Response

{
  "nextCursor": "string",
  "hasMore": false,
  "data": [
    {
      "id": "brd_3f9e2a",
      "title": "Q4 Launch Planning",
      "spaceId": "spc_92kd",
      "url": "https://app.mockflow.com/board/3f9e2a",
      "publicUrl": "https://app.mockflow.com/board/brd_3f9e2a",
      "role": "owner"
    }
  ]
}

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

Boards the token can read: the workspace's own, boards shared with the person, and boards in spaces shared with them. Inside a space the default order is the dashboard's manual order; otherwise most recently updated first. deleted=true lists the workspace's own trash.

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.

Query parameters

spaceIdstringquery

A space id, or default for boards in no space.

qstringquery

Match against the title.

deletedbooleanquery

Defaults to false.

sortenum<string>query

One of position, updatedAt, createdAt or title.

orderenum<string>query

One of asc or desc.

cursorstringquery

Opaque cursor from a previous response's nextCursor.

limitintegerquery

Defaults to 50.

Response

200 · application/json

nextCursorstring | null

hasMoreboolean

dataBoard[]

Child attributes

idstring

titlestring

spaceIdstring | null

The design space, or null for the default space.

urlstring

Opens the board in the editor.

publicUrlstring | null

The public viewer link, when the public link is on.

roleenum<string>

The product's roles. Owner is the workspace that holds the board or space and cannot be granted or transferred. Admin can rename and share, editor can edit, reviewer can view, export and add comment items. There is no viewer role and no pending state. One of owner, admin, editor or reviewer.

lockedboolean

Locked boards are read only for everyone.

positioninteger | null

Manual order inside the space, lowest first.

createdBystring

createdAtstring

updatedAtstring

deletedAtstring | null

Set while the board is in the trash.

Errors

429rate_limited

Too many requests.

Was this page helpful?