Get a brand kit

GET /brand-kits/{kitId}

Updated 9 Nov 20262 min read

GET/brand-kits/{kitId}Try it

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

Request

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

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

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

Response

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

One kit, with instructions, the text Mida follows when you pass the kit to a generation. 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.

Path parameters

kitIdstringpathrequired

Query parameters

boardIdstringquery

A board you are on (brd_…), for a kit of that board's team.

Response

200 · application/json

idstring

namestring

colorsobject[]

Most important first.

Child attributes

namestring

hexstring

headingFontstring | null

bodyFontstring | null

rulesstring

The kit's voice and brand rules.

logosobject[]

Child attributes

roleenum<string>

main, for dark backgrounds, or the square icon. One of main, dark or icon.

urlstring

widthinteger

heightinteger

instructionsstring

The whole kit as the text Mida follows.

Errors

402plan_limit

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

404not_found

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

429rate_limited

Too many requests.

Was this page helpful?