API-Referenz

Die Flowtly REST-API — 927 Endpunkte in 192 Ressourcen, generiert aus dem aktuellen OpenAPI-Schema.

Diese Referenz wird aus dem API-Schema generiert. Feldbeschreibungen und alle noch nicht übersetzten Texte werden auf Englisch angezeigt.

Testphase starten und Token erhalten Mit dem Vertrieb sprechen

Bevor Sie bauen

Authentifizierung

Senden Sie ein persönliches Zugriffstoken im Header Authorization: Bearer <token>. Sie erstellen es in Flowtly auf der Sicherheitsseite Ihres Profils. Ein Token handelt mit Ihren eigenen Berechtigungen, gilt 365 Tage, sofern Sie nichts anderes wählen (höchstens 730), und lässt sich dort jederzeit widerrufen.

Organisations-Header

Jede Anfrage enthält außerdem einen instance-Header mit der ID der Organisation, in der Sie handeln. Ohne ihn lehnt die API die Anfrage ab.

Anfragen und Antworten

Antworten sind JSON-LD (application/ld+json) oder einfaches JSON (application/json). Aktualisierungen verwenden PATCH mit application/merge-patch+json. Sammlungen werden mit page und itemsPerPage seitenweise abgerufen, höchstens 500 Einträge pro Seite.

Versionierung

Die API ist weder in Pfaden noch in Headern versioniert: Ressourcen liegen im Wurzelverzeichnis, zum Beispiel https://api.flowtly.eu/projects. Das OpenAPI-3.1-Dokument ist unter https://api.flowtly.eu/docs.json veröffentlicht.

Ratenlimits

Anfragen unterliegen Ratenlimits. Schreibende Anfragen (POST, PUT, PATCH, DELETE) werden pro Organisation in einem Fünf-Minuten-Fenster gezählt, mit einem höheren Limit, sobald die Organisation verifiziert ist oder ein Abonnement hat. Bei Überschreitung antwortet die API mit 429 Too Many Requests und einem Retry-After-Header, der die Wartezeit in Sekunden angibt. Die Limits können sich ändern, lesen Sie daher Retry-After, statt eine Zahl fest einzutragen.

Veraltete Funktionen

Ein Endpunkt oder Feld, das abgeschafft wird, ist im OpenAPI-Dokument als deprecated markiert. Die API sendet keine Deprecation-Header, prüfen Sie also das Dokument, wenn Sie eine Integration aktualisieren.

Integration testen

Es gibt keine separate Sandbox. Testen Sie Ihre Integration in einem Test-Workspace mit Beispieldaten, bevor Sie Echtdaten anbinden. Solange die Organisation weder verifiziert ist noch ein Abonnement hat, läuft ein Test mit einem niedrigeren Schreiblimit und versendet keine E-Mails.

Was sich geändert hat

Änderungen an der API werden zusammen mit dem übrigen Produkt in den Versionshinweisen angekündigt.

Versionshinweise lesen

Projekte & Lieferung

Projekte, Aufgaben, Mitglieder, Sätze und Zuweisungen — automatisieren Sie die Leistungserbringung und synchronisieren Sie Projektdaten.

Ressourcenplanung & Kapazität

Zuweisungen, der Pool, das Zeitfenster des Plans und die Ist-Daten — planen Sie, wer woran arbeitet, und lesen Sie aus, was tatsächlich getan wurde.

Rechnungen & Zahlungen

Rechnungen, Positionen, Zahlungen, Erinnerungen und E-Rechnung (KSeF) — automatisieren Sie die Abrechnung durchgängig.

Budgets & Ausgaben

159

Budgets, Transaktionen, Kosten, Steuern und Bankkonten — Ausgaben verfolgen und automatisch abgleichen.

CRM — Leads & Deals

Leads, Deals, Pipelines und Phasen — steuern Sie den Vertriebstrichter aus Ihren eigenen Systemen.

Kunden & Geschäftspartner

Kunden, Kontakte und Geschäftspartner — synchronisiere dein CRM mit Flowtly.

HR & Personal

Mitarbeiter, Abteilungen, Positionen, Benefits und Zuständigkeiten — automatisieren Sie HR-Datenflüsse.

Leistung & Reviews

Review-Zyklen, Vorlagen, Fragen und Sitzungen — führen Sie Leistungsbeurteilungen programmatisch durch.

Zeit & Anwesenheit

Arbeitszeit, Urlaub, Zeitpläne und Feiertage — protokollieren und lesen Sie Anwesenheitsdaten programmatisch.

Rekrutierung & ATS

Kandidaten, Recruiting-Aufgaben, Interviews und Terminplanung — binden Sie Ihr ATS an.

Immobilie & Vermögenswerte

Immobilien, Buchungen, Anlagen, Zähler und Zählerstände — verwalten Sie Immobiliendaten über die API.

Verträge & Compliance

Vereinbarungen, Verträge, Anhänge und Zahlungspläne — automatisieren Sie Vertragsabläufe.

Dokumente & Unterschriften

Dokumente, Ablage und E-Signatur-Anfragen — Dateien hochladen, organisieren und unterschreiben.

Anpassung & Tags

Attribute, Attributsets, Regeln und Tags — erweitern Sie Flowtly-Objekte um eigene Felder.

Organisation & Konfiguration

Organisation, Standorte, Benutzer, Integrationen und Abonnement — konfigurieren Sie den Arbeitsbereich.

Benutzer & Zugriff

Benutzer und Berechtigungsgruppen — verwalten Sie, wer was sehen und tun darf.

Webhooks & Audit

Webhooks und Audit-Protokolle — reagieren Sie auf Ereignisse und verfolgen Sie Änderungen.

Buchhaltungsexporte

Exporte nach Wapro, Optima, Enova, Symfonia, MT940 und SEPA — übergeben Sie Daten an Ihren Steuerberater.

MCP Server

Verbinde AI-Tools mit Flowtly über das Model Context Protocol unter mcp.flowtly.eu.