OpenAPI 3.0.3

API & MCP

Verbinden Sie Claribill mit Ihrer Buchhaltung, Ihrem Shop oder eigenen Anwendungen. Die REST-API deckt die Funktionen des Dashboards ab – mit interaktivem Explorer, Code-Beispielen und einer OpenAPI-Spezifikation zum Download.

OpenAPI-Spezifikation

REST-API v1

142 Endpunkte in 15 Bereichen – Rechnungen, Kunden, Belege, Exporte und mehr.

Sichere Schlüssel

API-Schlüssel mit Präfix sk_live_, je Firma und mit 23 fein abgestuften Scopes.

OpenAPI 3.0

Vollständige Spezifikation zum Download – für Postman, Insomnia, Code-Generatoren und eigene SDKs.

Limits

100 Anfragen pro Minute je Schlüssel. Monatskontingent: Professional: 50.000 · Enterprise: 250.000.

Schnellstart

Basis-URL https://www.claribill.com/api/v1. Standardantworten verwenden JSON mit einer data-Hülle; Listen ergänzen pagination. Blog-Routen und Dateidownloads verwenden die im Explorer dokumentierten eigenen Formate.

# Versendete Rechnungen abrufen
curl "https://www.claribill.com/api/v1/invoices?status=SENT&limit=10" \
  -H "Authorization: Bearer $CLARIBILL_API_KEY"

# Rechnungsentwurf anlegen
curl -X POST "https://www.claribill.com/api/v1/invoices" \
  -H "Authorization: Bearer $CLARIBILL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "KUNDEN_ID",
    "documentLocale": "de",
    "lines": [
      { "description": "Beratung", "quantity": 10, "unitPrice": 150, "taxRate": 20 }
    ]
  }'

Authentifizierung

Senden Sie Ihren API-Schlüssel bei jeder Anfrage im Authorization-Header. Der Schlüssel gehört zu genau einer Firma; alle Abfragen sind auf diese Firma beschränkt. Welche Endpunkte ein Schlüssel nutzen darf, legen seine Scopes fest.

Authorization: Bearer sk_live_…

Im API-Explorer tragen Sie den Schlüssel über Authorize ein und können jede Anfrage mit Try it out direkt gegen Ihre Firma ausführen. Der Schlüssel wird nicht gespeichert.

Webhooks

Claribill kann Ereignisse wie versendete oder bezahlte Rechnungen per HMAC-signiertem Webhook an Ihr System melden (Enterprise). Die Endpunkte finden Sie unter webhooks im Explorer, die Ereignisliste in der Dokumentation. Dokumentation

KI-Assistent und eigene Agenten

Der KI-Assistent im Dashboard hat keine eigene öffentliche API. Er nutzt dieselben Funktionen wie Dashboard und REST-API; Rechte, Sichtbarkeit und Plan-Limits gelten gleich, und alles mit Außenwirkung bestätigt der Benutzer vorher. Eigene Agenten binden Sie über die REST-API oder den MCP-Server (OAuth 2.1) an. Zur Anleitung des KI-Assistenten

API & MCP | Claribill