Boards API

API-Endpunkte zum Auflisten und Abrufen von Boards.

Pro-Funktion

Boards sind die obersten Organisationseinheiten in Kanman. Die Boards API ermöglicht es Ihnen, Board-Informationen programmgesteuert abzurufen. Sie können alle Boards in Ihrem Arbeitsbereich auflisten, Details zu einzelnen Boards abrufen und die Projekte innerhalb eines Boards einsehen.

Da Boards den Container für Ihre gesamte Arbeit darstellen, ist die Boards API oft der Ausgangspunkt für Integrationen. Von hier aus können Sie zu Projekten und deren Aufgaben navigieren.

Boards auflisten

Rufen Sie alle Boards in Ihrem Arbeitsbereich ab.

Endpunkt

GET /boards

Erforderliche Berechtigung

read

Antwort

{
  "boards": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Marketing",
      "description": "Marketing-Team-Projekte",
      "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": "Produktentwicklung",
      "description": null,
      "icon": "code",
      "accent_color": "#7dd3fc",
      "created_at": "2024-01-10T09:00:00Z",
      "updated_at": "2024-01-19T16:20:00Z"
    }
  ]
}

Beispiel

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

Board abrufen

Rufen Sie ein bestimmtes Board anhand seiner ID ab.

Endpunkt

GET /boards/:id

Parameter

Parameter Typ Beschreibung
id string Board-UUID

Erforderliche Berechtigung

read

Antwort

{
  "board": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Marketing",
    "description": "Marketing-Team-Projekte und Kampagnen",
    "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"
  }
}

Beispiel

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

Fehler

Status Fehler Beschreibung
404 board_not_found Board existiert nicht oder Sie haben keinen Zugriff

Board-Projekte auflisten

Rufen Sie alle Projekte innerhalb eines bestimmten Boards ab.

Endpunkt

GET /boards/:id/projects

Parameter

Parameter Typ Beschreibung
id string Board-UUID

Erforderliche Berechtigung

read

Antwort

{
  "projects": [
    {
      "id": "660e8400-e29b-41d4-a716-446655440000",
      "name": "Q1 Kampagne",
      "description": "Frühlings-Marketing-Kampagne",
      "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"
    }
  ]
}

Beispiel

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

Board-Objekt

Vollständige Board-Objektstruktur:

Feld Typ Beschreibung
id string Eindeutige Kennung (UUID)
name string Board-Name (max. 255 Zeichen)
description string Board-Beschreibung (nullable)
icon string Lucide-Icon-Name (nullable)
accent_color string Hex-Farbcode (nullable)
background_color string Hex-Hintergrundfarbe (nullable)
background_image_url string Unsplash-Bild-URL (nullable)
layout_preference string simple oder kanban
created_at string ISO 8601 Zeitstempel
updated_at string ISO 8601 Zeitstempel

Hinweise

  • Die Boards API ist derzeit schreibgeschützt
  • Erstellen-, Aktualisieren- und Löschen-Operationen sind in der Web-Oberfläche verfügbar
  • Um Boards programmgesteuert zu ändern, kontaktieren Sie uns für erweiterten API-Zugriff

Verwandte Themen

Zuletzt aktualisiert: January 1, 0001

Kanman testen