---
title: "Create a board"
method: POST
path: "/api/boards"
tags: ["Boards"]
---

# Create a board

`POST /api/boards`

## Request

- Base URL: `https://tre-app.com`
- URL: `https://tre-app.com/api/boards`
- Auth: HTTP bearer

A private board is any workspace member's to create; a shared one takes an owner or admin of the workspace. A read-only workspace — suspended by the operator, or with a trial that ran out, a canceled subscription or no plan chosen — answers 403 and creates nothing: the message says which.

## Headers

- `Idempotency-Key` string

## Request body

- BoardCreate
  - `name` string, required
  - `keyPrefix` string
  - `isPrivate` boolean
  - `workspace` string

## Response `201`

Success

- Board
  - `id` string, uuid, required
  - `slug` string, required
  - `name` string, required
  - `title` string, required
  - `keyPrefix` string, required
  - `order` integer, required
  - `createdAt` string, date-time, required
  - `archivedAt` string, date-time, nullable, required
  - `backgroundKind` 'color' | 'gradient' | 'image', nullable, required
  - `backgroundValue` string, nullable, required
  - `isPrivate` boolean, required

## Other responses

- `400`: Invalid request
- `401`: Unauthenticated
- `403`: Forbidden: insufficient role or token scope; scope denials name the held scope and the operation
- `404`: Not found
- `409`: Conflict
- `422`: Idempotency-Key reused with a different request body (IDEMPOTENCY_KEY_REUSED)
- `429`: Rate limited
- `500`: Internal server error
- `503`: Temporarily unavailable

---

[API](https://skmtc.dev/tre-app/apis/tre-rest-api.md) · [All operations](https://skmtc.dev/tre-app/apis/tre-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tre-app/apis/tre-rest-api/revisions/26a7187a05fc?raw)