# Get a brand kit

> GET /brand-kits/{kitId}

Source: https://mockflow.com/developers/reference/brand-kits/get-brand-kit

**GET** `https://api.mockflow.com/v1/brand-kits/{kitId}`  
Scopes: `user:read`

**curl**

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

**JavaScript**

```javascript
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();
```

**Python**

```python
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()
```

**200**

```json
{
  "id": "bk_K3f9a0c1d2e4b5a6978869a0b1c2d3e4f",
  "name": "Q4 Launch Planning",
  "colors": [
    {
      "name": "Q4 Launch Planning",
      "hex": "#1c7ce2"
    }
  ],
  "headingFont": "string",
  "bodyFont": "string",
  "rules": "string"
}
```

**402**

```json
{
  "error": {
    "code": "plan_limit",
    "message": "AI credits exhausted. 0 of 2000 remaining this month.",
    "upgradeUrl": "https://mockflow.com/pricing"
  },
  "requestId": "req_01ja"
}
```

**404**

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

**429**

```json
{
  "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

- `Authorization` (string, required): `Bearer <key>`. The key needs `user:read` scope. Create and manage keys in the [developer console](/developers/console/), or use an [OAuth app](/developers/concepts/oauth-apps) to act for other people; what each scope unlocks is on the [scopes page](/developers/concepts/scopes).

### Path parameters

- `kitId` (string, required)

### Query parameters

- `boardId` (string): A board you are on (brd_…), for a kit of that board's team.

### Response

- `id` (string)
- `name` (string)
- `colors` (object[]): Most important first.
    - `name` (string)
  - `hex` (string)
- `headingFont` (string | null)
- `bodyFont` (string | null)
- `rules` (string): The kit's voice and brand rules.
- `logos` (object[]): - `role` (enum<string>): main, for dark backgrounds, or the square icon. One of `main`, `dark` or `icon`.
  - `url` (string)
  - `width` (integer)
  - `height` (integer)
- `instructions` (string): The whole kit as the text Mida follows.

### Errors

- 402 `plan_limit`: The workspace plan does not allow this, or AI credits are exhausted.
- 404 `not_found`: The resource does not exist or the token cannot see it.
- 429 `rate_limited`: Too many requests.