API für Entwickler

Noch nicht in der API

Einige Recherche-Funktionen der Forderungsansicht gibt es bisher nur im Dashboard: Melderegisteranfragen, Adressrecherche, Finanzlage und Empfehlungen der Gläubiger-KI sowie das Aktivitätsprotokoll. Sie folgen in einer späteren Version; neue Endpunkte stehen im Änderungsprotokoll.

Basis-URL

https://www.debt-flow.io/api/v1

Jede Antwort trägt den Header DebtFlow-Version: 2026-11-01. Er nennt das Datum der letzten inkompatiblen Änderung; Erweiterungen (neue Felder, neue Endpunkte) erhöhen ihn nicht. Ihr Code sollte unbekannte Felder daher ignorieren.

Erster Aufruf in drei Schritten

Im Dashboard unter Einstellungen → Entwickler einen API-Schlüssel anlegen und die nötigen Berechtigungen wählen. Der Schlüssel beginnt mit df_live_ und wird nur einmal angezeigt.
Den Schlüssel als Umgebungsvariable DEBTFLOW_API_KEY hinterlegen – nie im Quelltext oder im Browser.
GET /me aufrufen. Die Antwort zeigt Ihr Konto und die Berechtigungen des Schlüssels.

curl 'https://www.debt-flow.io/api/v1/me' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Antwort 200

{
  "id": "Xk2pQ9…",
  "email": "[email protected]",
  "firstName": "Erika",
  "lastName": "Muster",
  "company": "Muster GmbH",
  "approved": true,
  "auth": {
    "kind": "api_key",
    "scopes": [
      "contacts:read",
      "invoices:write"
    ],
    "apiKeyId": "ak_…"
  }
}

Konventionen

Thema	Format	Beispiel
Felder	camelCase	`issueDate`
Beträge	ganze Cent (Integer), Währung EUR	`12550`
Kalenderdaten	YYYY-MM-DD	`2026-11-30`
Zeitpunkte	ISO 8601 mit Zeitzone	`2026-11-04T09:30:00.000Z`
Länder	ISO 3166-1 alpha-2	`DE`
Aufzählungen	snake_case	`partially_paid`
IDs	undurchsichtige Zeichenketten, teils mit Präfix	`evt_…`
Listen	Cursor-Pagination	limit, cursor

Beträge in Cent vermeiden Rundungsfehler: 125,50 € werden als 12550 übertragen. Steuerbeträge berechnet DebtFlow selbst aus Positionen, Steuersatz und Steuerbehandlung.

OpenAPI-Beschreibung

Die vollständige Beschreibung im Format OpenAPI 3.1 liegt unter /api/v1/openapi.json. Sie lässt sich in Postman, Insomnia oder Code-Generatoren importieren und enthält auch alle Webhook-Ereignisse. Die API-Referenz auf dieser Website wird aus derselben Datei erzeugt.

Themen

Authentifizierung – API-Schlüssel für eigene Skripte und OAuth 2.0 mit PKCE für Apps, die andere DebtFlow-Konten verbinden.
Berechtigungen – Alle Scopes der API v1: Lesen und Ändern je Bereich, was ein API-Schlüssel oder eine App darf.
Fehler – Einheitliches Fehlerformat, HTTP-Status und alle Fehlercodes der DebtFlow-API.
Pagination – Listen mit Cursor-Pagination: limit, cursor, hasMore und nextCursor mit Beispielen.
Idempotenz – POST-Anfragen sicher wiederholen mit dem Header Idempotency-Key.
Rate-Limits – Wie viele Anfragen pro Minute erlaubt sind, die Header X-RateLimit-* und der Umgang mit 429.
Webhooks – Ereignisse in Echtzeit empfangen, Signatur DebtFlow-Signature prüfen, Wiederholungen und Ereigniskatalog.
API-Referenz – Alle Endpunkte der DebtFlow-API v1 mit Parametern, Antworten und Beispielen – erzeugt aus der OpenAPI-Beschreibung.
Änderungsprotokoll – Versionen und Änderungen der DebtFlow-API.
Zapier, Make und n8n – DebtFlow ohne eigenen Code mit Zapier, Make und n8n verbinden.

DebtFlow API

Basis-URL

Erster Aufruf in drei Schritten

Konventionen

OpenAPI-Beschreibung

Themen