Entwickler
Die BoardArc REST-API
Boards und Aufgaben aus jedem Programm lesen und schreiben – mit einem API-Schlüssel, der nie mehr darf als die Person, die ihn erstellt hat.
30 Tage alle Funktionen gratis · Keine Kreditkarte · Server in der EU
Schnellstart in 10 Minuten
- In BoardArc: Einstellungen → Workspace → API & Webhooks → „Neuer Schlüssel“. Rechte wählen, Schlüssel kopieren.
- Ersten Aufruf machen: Boards auflisten.
- Mit der Board-ID eine Aufgabe anlegen – Status als Name, Person als E-Mail, Datum als JJJJ-MM-TT.
- Status ändern. Die Änderung erscheint sofort live im Board.
1. Boards auflisten
curl https://boardarc.com/api/public/v1/boards \ -H "Authorization: Bearer $BOARDARC_KEY"
2. Aufgabe anlegen
curl -X POST https://boardarc.com/api/public/v1/boards/<BOARD_ID>/items \
-H "Authorization: Bearer $BOARDARC_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: bestellung-10482" \
-d '{"name": "Bestellung 10482", "values": {"Status": "In Arbeit", "Person": "anna@firma.de", "Termin": "2026-10-01"}}'3. Status ändern
curl -X PATCH https://boardarc.com/api/public/v1/items/<ITEM_ID> \
-H "Authorization: Bearer $BOARDARC_KEY" \
-H "Content-Type: application/json" \
-d '{"values": {"Status": "Fertig"}}'Authentifizierung und Rechte
Jeder Aufruf braucht den Kopf „Authorization: Bearer ba_live_…“. Schlüssel werden bei uns nur verschlüsselt gespeichert und nach dem Erstellen nie wieder angezeigt. Jeder Schlüssel hat Rechte (Scopes) und kann auf bestimmte Boards begrenzt werden. Dazu gelten immer die Rechte des Erstellers: versteckte Spalten bleiben versteckt, gesperrte Spalten gesperrt. Boards außerhalb der Freigabe antworten mit 404, damit niemand erfährt, dass es sie gibt.
Rotieren erzeugt einen neuen Schlüssel, der alte läuft noch 24 Stunden. Widerrufen wirkt sofort. Die Schnittstelle ist für Server gedacht – bitte Schlüssel nie in Browser-Code einbauen.
Limits, Fehler, Paginierung
Free: 60 Anfragen pro Minute und 5.000 pro Tag. Bezahlte Tarife: 600 pro Minute und 100.000 pro Tag. Jede Antwort enthält X-RateLimit-Limit und X-RateLimit-Reset; bei Überschreitung kommt 429 mit Retry-After.
Fehler haben immer dieselbe Form:
{ "error": { "code": "validation_error", "message": "…", "field": "values.Status", "request_id": "…" } }Codes: unauthorized, forbidden, not_found, validation_error, rate_limited, conflict, internal. POST und PATCH akzeptieren einen Idempotency-Key – derselbe Schlüssel innerhalb von 24 Stunden liefert dieselbe Antwort, ohne doppelt anzulegen. Listen sind cursor-basiert (limit bis 200, next_cursor).
curl "https://boardarc.com/api/public/v1/boards/<BOARD_ID>/items?limit=200&filter[status]=Fertig" \ -H "Authorization: Bearer $BOARDARC_KEY" # Antwort enthält next_cursor – mit ?cursor=… weiterblättern
Endpunkte
Basis-Adresse: https://boardarc.com/api/public/v1 · OpenAPI 3.1
| Methode | Pfad | Scope | Zweck |
|---|---|---|---|
| GET | /health | – | Status der API |
| GET | /workspace | workspace:read | Workspace des Schlüssels |
| GET | /users | users:read | Mitglieder auflisten |
| GET | /users/{id} | users:read | Ein Mitglied |
| GET | /boards | boards:read | Boards, auf die der Schlüssel Zugriff hat |
| GET | /boards/{id} | boards:read | Ein Board |
| GET | /boards/{id}/columns | boards:read | Spalten mit Typ und Labels |
| GET | /boards/{id}/groups | boards:read | Gruppen |
| GET | /boards/{id}/items | items:read | Aufgaben mit Filter, Suche (q) und Cursor |
| POST | /boards/{id}/items | items:write | Aufgabe anlegen |
| GET | /items/{id} | items:read | Eine Aufgabe |
| PATCH | /items/{id} | items:write | Name oder Werte ändern |
| DELETE | /items/{id} | items:write | Aufgabe archivieren |
| GET | /items/{id}/subitems | items:read | Unteraufgaben |
| POST | /items/{id}/move | items:write | In andere Gruppe oder anderes Board verschieben |
| POST | /items/{id}/duplicate | items:write | Aufgabe duplizieren |
| POST | /items/batch | items:write | Bis zu 100 Aufgaben gleichzeitig ändern oder archivieren |
| GET | /items/{id}/updates | items:read | Kommentare einer Aufgabe lesen |
| POST | /items/{id}/updates | items:write | Kommentar an eine Aufgabe schreiben |
| GET | /items/{id}/files | items:read | Dateien einer Aufgabe auflisten |
| POST | /items/{id}/files | items:write | Datei hochladen (bis 20 MB) |
| GET | /usage | – | Nutzung des Schlüssels, letzte 30 Tage |
| GET | /docs | docs:read | Doc-Seiten auflisten |
| POST | /docs | docs:write | Seite anlegen (Titel + Klartext oder Inhalt) |
| GET | /docs/{id} | docs:read | Seite mit Inhalt lesen |
| PATCH | /docs/{id} | docs:write | Seite ändern |
| DELETE | /docs/{id} | docs:write | Seite archivieren |
| GET | /automations | automations:trigger | Abläufe auflisten, inkl. Adresse zum Auslösen |
| GET | /meta/column-types | – | Eingabeformate je Spaltentyp |
| GET | /meta/status-labels/{board_id} | boards:read | Status-Labels eines Boards |
In Arbeit: ausgehende Webhooks mit Signatur, Kommentare, Dateien, Chat, Docs, Abläufe, Arc, Zapier/Make und SDKs für JavaScript und Python.
Heute schon: eingehende Webhooks und HTTP-Schritt
Jeder Ablauf mit dem Auslöser „Webhook“ bekommt eine eigene geheime Adresse. Im Ablauf-Builder ruft der Schritt „HTTP-Anfrage“ jede https-Schnittstelle auf. Interne Netzwerkadressen sind gesperrt.
Häufige Fragen
Kann ein Schlüssel mehr als ich?
Nein. Er darf höchstens das, was du in der App darfst – und nur die Rechte, die du ihm gibst.
Was kostet die API?
Sie ist in allen Tarifen enthalten, mit höheren Limits ab Team.
Was passiert, wenn jemand meinen Schlüssel findet?
Widerrufe ihn unter Einstellungen → API & Webhooks. Er ist dann sofort ungültig.