Skip to content

Konventionen

Format

  • Requests & Responses: application/json.
  • IDs: UUID oder SID (Kurz-ID) werden bei den meisten Ressourcen akzeptiert.
  • Zeitstempel: ISO 8601 (UTC).

Authentifizierung

Bearer-Token im Authorization-Header. Ohne gültigen Token → 401.

Pagination

Listen-Endpunkte nehmen page und pageSize entgegen (nicht limit/offset) und liefern einen Envelope mit pagination-Objekt:

QueryTypDefaultBeschreibung
pagenumber ≥ 11Seite
pageSizenumber 1–10020*Einträge pro Seite
searchstringFreitextsuche (wo unterstützt)
sortstringSortierfeld (wo unterstützt)

* pageSize ist bei Lists und List Items standardmäßig 50.

json
{
  "data": [  ],
  "pagination": { "total": 128, "page": 1, "pageSize": 50, "totalPages": 3 }
}

Für die nächste Seite page erhöhen, bis page >= totalPages.

Unterschied zum MCP

Der MCP-Server nutzt ein anderes Schema: limit/offset als Eingabe und { items, total, limit, offset, has_more } als Antwort. Die REST-API nutzt page/pageSize und den pagination-Envelope oben.

HTTP-Statuscodes

CodeBedeutung
200OK
201Erstellt
400Ungültige Anfrage (Validierung)
401Nicht authentifiziert
403Keine Berechtigung
404Nicht gefunden
429Rate-Limit überschritten (siehe unten)

Rate Limiting

Wie beim MCP-Endpunkt: 240 Requests/Minute pro Token. Bei Überschreitung 429 mit Retry-After-Header.

Methoden-Semantik

  • GET — lesen
  • POST — anlegen
  • PATCH — teilweise aktualisieren (nur gesendete Felder ändern sich)
  • DELETE — löschen (bei Lists/Items: Soft-Delete → Papierkorb)

Liza Documentation