Restore a board from trash

POST /boards/{boardId}/restore

Updated 17 Sep 20262 min read

POST/boards/{boardId}/restoreTry it

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

Request

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

const response = await fetch("https://api.mockflow.com/v1/boards/brd_3f9e2a/restore", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`
  }
});

const data = await response.json();

import os, requests

response = requests.post(
    "https://api.mockflow.com/v1/boards/brd_3f9e2a/restore",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
)

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

Response

{
  "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": "plan_limit",
    "message": "AI credits exhausted. 0 of 2000 remaining this month.",
    "upgradeUrl": "https://mockflow.com/pricing"
  },
  "requestId": "req_01ja"
}

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

Plus and Max only. A board whose space is still in the trash comes back into the default space.

Authorization

Authorizationstringheaderrequired

Bearer <key>. The key needs boards:write 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

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

402plan_limit

The workspace plan does not allow this, or AI credits are exhausted.

429rate_limited

Too many requests.

Was this page helpful?