Spedy Docs

Boards sind der übergeordnete Container zur Organisation von Arbeit in Spedy. Jedes Board repräsentiert ein Projekt oder einen Arbeitsbereich und enthält Tickets, Status und Team-Zuweisungen.

Boards auflisten

GET /api/v1/boards

Query-Parameter

Parameter	Typ	Pflicht	Beschreibung
page	number	Nein	Seitennummer (Standard: 1)
limit	number	Nein	Einträge pro Seite (Standard: 20, max: 100)
search	string	Nein	Suche nach Board-Name oder Beschreibung
includeArchived	boolean	Nein	Archivierte Boards einschließen (Standard: false)
archivedOnly	boolean	Nein	Nur archivierte Boards anzeigen (Standard: false)

Beispiel-Response

{
  "data": [
    {
      "id": "brd_abc123",
      "name": "Website Redesign",
      "prefix": "WEB",
      "description": "Frontend-Überarbeitungsprojekt",
      "isArchived": false,
      "createdAt": "2025-01-15T10:00:00Z",
      "updatedAt": "2025-03-20T14:30:00Z"
    }
  ],
  "total": 5,
  "page": 1,
  "pageSize": 20,
  "totalPages": 1
}

Board erstellen

POST /api/v1/boards

Berechtigung erforderlich: boards:create

Request Body

Feld	Typ	Pflicht	Beschreibung
name	string	Ja	Board-Name (max. 100 Zeichen)
prefix	string	Nein	Benutzerdefiniertes Kürzel für Ticket-IDs, 2-10 alphanumerische Zeichen (wird automatisch generiert falls weggelassen)
description	string	Nein	Board-Beschreibung
teamIds	string[]	Nein	Team-IDs, die bei der Erstellung zugewiesen werden

Beispiel-Request

{
  "name": "Website Redesign",
  "prefix": "WEB",
  "description": "Frontend-Überarbeitungsprojekt",
  "teamIds": ["team_abc123"]
}

Board abrufen

GET /api/v1/boards/{boardId}

Gibt ein einzelnes Board mit seinen Team-Zuweisungen zurück.

Board aktualisieren

PATCH /api/v1/boards/{boardId}

Berechtigung erforderlich: boards:edit

Request Body

Feld	Typ	Pflicht	Beschreibung
name	string	Nein	Board-Name (max. 100 Zeichen)
description	string	Nein	Board-Beschreibung

Board löschen

DELETE /api/v1/boards/{boardId}

Berechtigung erforderlich: boards:delete

Löscht das Board und alle zugehörigen Daten dauerhaft. Gibt 204 No Content zurück.

Board archivieren

POST /api/v1/boards/{boardId}/archive

Berechtigung erforderlich: boards:edit

Archiviert das Board und entfernt es aus der aktiven Liste, ohne Daten zu löschen.

Board wiederherstellen

POST /api/v1/boards/{boardId}/unarchive

Berechtigung erforderlich: boards:edit

Stellt ein archiviertes Board in der aktiven Liste wieder her.

Team zu Board zuweisen

POST /api/v1/boards/{boardId}/teams

Berechtigung erforderlich: boards:manage-members

Request Body

Feld	Typ	Pflicht	Beschreibung
teamId	string	Ja	Zuzuweisende Team-ID

Team von Board entfernen

DELETE /api/v1/boards/{boardId}/teams/{teamId}

Berechtigung erforderlich: boards:manage-members

Entfernt ein Team vom Board. Gibt die Anzahl der Tickets zurück, die möglicherweise neu zugewiesen werden müssen.

Beispiel-Response

{
  "flaggedTicketCount": 3
}

Boards

Inhaltsverzeichnis