Boards API

API endpoints for listing and retrieving boards.

Pro Feature

Boards are the top-level organizational units in Kanman. The Boards API allows you to list and retrieve board information.

List Boards

Retrieve all boards in your workspace.

Endpoint

GET /boards

Required Scope

read

Response

{
  "boards": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Marketing",
      "description": "Marketing team projects",
      "icon": "megaphone",
      "accent_color": "#f5a524",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "name": "Product Development",
      "description": null,
      "icon": "code",
      "accent_color": "#7dd3fc",
      "created_at": "2024-01-10T09:00:00Z",
      "updated_at": "2024-01-19T16:20:00Z"
    }
  ]
}

Example

curl https://api.kanman.de/v1/boards \
  -H "Authorization: Bearer km_your_api_token"

Get Board

Retrieve a specific board by ID.

Endpoint

GET /boards/:id

Parameters

Parameter Type Description
id string Board UUID

Required Scope

read

Response

{
  "board": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Marketing",
    "description": "Marketing team projects and campaigns",
    "icon": "megaphone",
    "accent_color": "#f5a524",
    "background_color": "#1a1a2e",
    "layout_preference": "kanban",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z"
  }
}

Example

curl https://api.kanman.de/v1/boards/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer km_your_api_token"

Errors

Status Error Description
404 board_not_found Board doesn’t exist or you don’t have access

List Board Projects

Retrieve all projects within a specific board.

Endpoint

GET /boards/:id/projects

Parameters

Parameter Type Description
id string Board UUID

Required Scope

read

Response

{
  "projects": [
    {
      "id": "660e8400-e29b-41d4-a716-446655440000",
      "name": "Q1 Campaign",
      "description": "Spring marketing campaign",
      "position": "aaa",
      "num_tasks_open": 5,
      "num_tasks_in_progress": 3,
      "num_tasks_done": 12,
      "num_tasks_total": 20,
      "progress": 0.6,
      "created_at": "2024-01-15T10:35:00Z",
      "updated_at": "2024-01-20T14:45:00Z"
    },
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "name": "Website Redesign",
      "description": null,
      "position": "aab",
      "num_tasks_open": 8,
      "num_tasks_in_progress": 2,
      "num_tasks_done": 0,
      "num_tasks_total": 10,
      "progress": 0.0,
      "created_at": "2024-01-18T09:00:00Z",
      "updated_at": "2024-01-18T09:00:00Z"
    }
  ]
}

Example

curl https://api.kanman.de/v1/boards/550e8400-e29b-41d4-a716-446655440000/projects \
  -H "Authorization: Bearer km_your_api_token"

Board Object

Complete board object structure:

Field Type Description
id string Unique identifier (UUID)
name string Board name (max 255 chars)
description string Board description (nullable)
icon string Lucide icon name (nullable)
accent_color string Hex color code (nullable)
background_color string Hex background color (nullable)
background_image_url string Unsplash image URL (nullable)
layout_preference string simple or kanban
created_at string ISO 8601 timestamp
updated_at string ISO 8601 timestamp

Notes

  • Boards API is currently read-only
  • Create, update, and delete operations are available in the web UI
  • To modify boards programmatically, please contact us for extended API access

Last updated: January 1, 0001

Try Kanman