Project

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/planka/main/json-schema/planka-project-schema.json",
  "title": "Project",
  "x-generated": "2026-10-27",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/planka-openapi.json#/components/schemas/Project",
  "type": "object",
  "required": [
    "id",
    "ownerProjectManagerId",
    "backgroundImageId",
    "name",
    "description",
    "backgroundType",
    "backgroundGradient",
    "isHidden",
    "createdAt",
    "updatedAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the project"
    },
    "ownerProjectManagerId": {
      "type": [
        "string",
        "null"
      ],
      "description": "ID of the project manager who owns the project"
    },
    "backgroundImageId": {
      "type": [
        "string",
        "null"
      ],
      "description": "ID of the background image used as background"
    },
    "name": {
      "type": "string",
      "description": "Name/title of the project"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Detailed description of the project"
    },
    "backgroundType": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "gradient",
        "image"
      ],
      "description": "Type of background for the project"
    },
    "backgroundGradient": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "old-lime",
        "ocean-dive",
        "tzepesch-style",
        "jungle-mesh",
        "strawberry-dust",
        "purple-rose",
        "sun-scream",
        "warm-rust",
        "sky-change",
        "green-eyes",
        "blue-xchange",
        "blood-orange",
        "sour-peel",
        "green-ninja",
        "algae-green",
        "coral-reef",
        "steel-grey",
        "heat-waves",
        "velvet-lounge",
        "purple-rain",
        "blue-steel",
        "blueish-curve",
        "prism-light",
        "green-mist",
        "red-curtain"
      ],
      "description": "Gradient background for the project"
    },
    "isHidden": {
      "type": "boolean",
      "default": false,
      "description": "Whether the project is hidden"
    },
    "createdAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the project was created"
    },
    "updatedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the project was last updated"
    }
  }
}