Board

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/planka/main/json-schema/planka-board-schema.json",
  "title": "Board",
  "x-generated": "2026-10-27",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/planka-openapi.json#/components/schemas/Board",
  "type": "object",
  "required": [
    "id",
    "projectId",
    "position",
    "name",
    "defaultView",
    "defaultCardType",
    "limitCardTypesToDefaultOne",
    "alwaysDisplayCardCreator",
    "expandTaskListsByDefault",
    "createdAt",
    "updatedAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the board"
    },
    "projectId": {
      "type": "string",
      "description": "ID of the project the board belongs to"
    },
    "position": {
      "type": "number",
      "description": "Position of the board within the project"
    },
    "name": {
      "type": "string",
      "description": "Name/title of the board"
    },
    "defaultView": {
      "type": "string",
      "enum": [
        "kanban",
        "grid",
        "list"
      ],
      "default": "kanban",
      "description": "Default view for the board"
    },
    "defaultCardType": {
      "type": "string",
      "enum": [
        "project",
        "story"
      ],
      "default": "project",
      "description": "Default card type for new cards"
    },
    "limitCardTypesToDefaultOne": {
      "type": "boolean",
      "default": false,
      "description": "Whether to limit card types to default one"
    },
    "alwaysDisplayCardCreator": {
      "type": "boolean",
      "default": false,
      "description": "Whether to always display the card creator"
    },
    "expandTaskListsByDefault": {
      "type": "boolean",
      "default": false,
      "description": "Whether to expand task lists by default"
    },
    "createdAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the board was created"
    },
    "updatedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the board was last updated"
    }
  }
}