Get a space

GET /spaces/{spaceId}

Updated 16 Sep 20261 min read

GET/spaces/{spaceId}Try it

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

Request

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

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

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

Response

{
  "id": "string",
  "name": "Q4 Launch Planning",
  "builtIn": false,
  "role": "owner",
  "boardCount": 0,
  "memberCount": 0
}

{
  "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"
}

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

spaceIdstringpathrequired

Response

200 · application/json

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

404not_found

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

429rate_limited

Too many requests.

Was this page helpful?