List design spaces

GET /spaces

Updated 16 Sep 20262 min read

GET/spacesTry it

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

Request

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

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

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

Response

{
  "nextCursor": "string",
  "hasMore": false,
  "data": [
    {
      "id": "string",
      "name": "Q4 Launch Planning",
      "builtIn": false,
      "role": "owner",
      "boardCount": 0,
      "memberCount": 0
    }
  ]
}

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

Every space the token can see, in dashboard order: the workspace's own, the ones shared with the person, and the two built-in spaces default (boards in no space) and 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

cursorstringquery

Opaque cursor from a previous response's nextCursor.

limitintegerquery

Defaults to 50.

Response

200 · application/json

nextCursorstring | null

hasMoreboolean

dataSpace[]

Child attributes

idstring

A space id, or the reserved default and trash.

namestring

builtInboolean

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.

boardCountinteger

memberCountinteger

coverUrlstring | null

publicUrlstring | null

positioninteger

Dashboard order, lowest first.

createdBystring | null

createdAtstring | null

updatedAtstring | null

deletedAtstring | null

Errors

429rate_limited

Too many requests.

Was this page helpful?