List brand kits

GET /brand-kits

Updated 9 Nov 20262 min read

GET/brand-kitsTry it

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

Request

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

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

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

Response

{
  "nextCursor": "string",
  "hasMore": false,
  "data": [
    {
      "id": "bk_K3f9a0c1d2e4b5a6978869a0b1c2d3e4f",
      "name": "Q4 Launch Planning",
      "colors": [
        {
          "name": "Q4 Launch Planning",
          "hex": "#1c7ce2"
        }
      ],
      "headingFont": "string",
      "bodyFont": "string",
      "rules": "string"
    }
  ]
}

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

Your team's brand kits. With boardId, also the kits of that board's team, when you are on the board. Kits are made and edited in the editor (AI Skills, Brand kits) by team admins. Plus and Max only.

Authorization

Authorizationstringheaderrequired

Bearer <key>. The key needs user:read scope. Create and manage keys in the developer console, or use an OAuth app to act for other people; what each scope unlocks is on the scopes page.

Query parameters

boardIdstringquery

A board you are on (brd_…), to include its team's kits.

cursorstringquery

Opaque cursor from a previous response's nextCursor.

limitintegerquery

Defaults to 50.

Response

200 · application/json

nextCursorstring | null

hasMoreboolean

dataBrandKit[]

Child attributes

idstring

namestring

colorsobject[]

Most important first.

headingFontstring | null

bodyFontstring | null

rulesstring

The kit's voice and brand rules.

logosobject[]

instructionsstring

The whole kit as the text Mida follows.

Errors

402plan_limit

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

429rate_limited

Too many requests.

Was this page helpful?