Die öffentliche API von Tomorro ermöglicht den Datenaustausch zwischen Tomorro und der Software, die Ihre Teams bereits nutzen: CRM, ERP, HR-System, Data Warehouse, Automatisierungsplattform (Make, Zapier, n8n) oder interne Anwendung.
Es handelt sich um eine REST-API: Sie können Verträge, Vertragspartner, Klauseln, Mitglieder und weitere Objekte aus Ihren eigenen Tools lesen, suchen, erstellen und aktualisieren, ohne dass jemand die Daten erneut in Tomorro eingeben muss.
Technische Dokumentation: https://alpha.developer.tomorro.com/quickstart
Dort finden Sie jeden Endpunkt, seine Parameter und Beispielanfragen. Diese Dokumentation ist nur auf Englisch verfügbar.
Was Sie mit der API tun können
Verträge
Verträge auflisten und durchsuchen, mit Filtern auf Status, Vertragstyp, Vertragspartner oder Daten.
Einen Vertrag mit seinen Feldern, Unterzeichnern und Teilnehmern abrufen, oder seine konsolidierte Fassung, deren Werte die Nachträge berücksichtigen.
Die einem Vertrag zugeordneten Klauseln auflisten.
Das aktuelle Arbeitsdokument, die Dokumente im Signaturprozess oder die unterzeichneten PDF-Dateien herunterladen.
Einen Vertrag aus einem Vertragstyp und einer Vorlage erstellen, vorausgefüllt mit seinen Feldern, seinem Vertragspartner und seinen Unterzeichnern, in einem einzigen Aufruf.
Einen Vertrag aktualisieren: Felder, Vertragspartner, Unterzeichner, Teilnehmer.
Eine neue Version des Dokuments hochladen oder einen Anhang hinzufügen.
Einen Vertrag zur Unterschrift versenden oder eine laufende Signatur abbrechen.
Einen Vertrag anhand von PDF-Dateien, die in einem anderen Tool unterzeichnet wurden, als unterzeichnet markieren.
Vertragspartner
Vertragspartner auflisten und durchsuchen, das Profil eines Vertragspartners abrufen.
Einen Vertragspartner erstellen, aktualisieren (Name, Status, Felder) oder archivieren.
Vertragstypen und Vorlagen
Die Vertragstypen Ihrer Organisation auflisten.
Die Vorlagen eines Vertragstyps nach Sprache auflisten und den Inhalt einer Vorlage lesen.
Das Erstellungsformular eines Vertragstyps abrufen, also die Felder, die für die Erstellung eines Vertrags erforderlich sind.
Intelligente Felder
Die auf Ihren Verträgen konfigurierten intelligenten Felder auflisten.
Die Optionen eines Auswahlfelds oder Mehrfachauswahlfelds auflisten.
Benutzerdefinierte Objekte
Benutzerdefinierte Objekte auflisten und eines davon mit seinen Feldern abrufen.
Die Einträge auflisten, erstellen oder aktualisieren, die ein Vertrag für ein benutzerdefiniertes Objekt enthält.
Klauseln
Die Klauselbibliothek auflisten, eine Klausel mit ihrem Inhalt abrufen, eine Klausel hinzufügen.
Mitglieder
Mitglieder auflisten, mit Filtern auf Rolle, Status oder E-Mail-Adresse, und ein Mitglied abrufen.
Ein Mitglied erstellen, mit oder ohne Einladungs-E-Mail.
Rolle, Status, Gruppen oder Ordner eines Mitglieds aktualisieren.
Eine Abwesenheit einsehen, festlegen oder beenden.
Anhänge und Dokumente
Einen sicheren Upload-Link erhalten, um eine Datei zu senden, bevor sie einem Vertrag zugeordnet wird: neue Version, Anhang oder unterzeichnete PDF-Dateien.
Organisation und Audit-Protokoll
Die Organisation abrufen, zu der der API-Schlüssel gehört.
Die Ereignisse des Audit-Protokolls auflisten, wenn das Audit-Protokoll für Ihre Organisation aktiviert ist.
Wer die API nutzen kann
Der Zugang erfolgt über einen API-Schlüssel. Jeder Schlüssel gehört zu einem Mitglied Ihrer Organisation, und die API sieht und ändert nur das, was dieses Mitglied in Tomorro ohnehin sehen und ändern darf.
Der Schlüssel wird im Tab Integrationen von Tomorro erzeugt, Bereich API > API-Schlüssel generieren.
Bei den Standardrollen können die Rollen Admin, Manager und Mitarbeiter einen Schlüssel erzeugen. Die Rollen Leseberechtigter und Unterzeichner können das nicht. Mit der Option Benutzerdefinierte Rollen benötigen Sie eine Rolle, deren Berechtigung Integrationen die Aktion Verwenden umfasst.
Der Zugang zur API kann je nach dem Plan Ihrer Organisation variieren ; Bei Fragen zur Verfügbarkeit wenden Sie sich bitte an Ihren Kundenbetreuer.
Halten Sie Ihren Schlüssel geheim. Jede über die API vorgenommene Änderung ist eine echte Änderung in Ihrem Arbeitsbereich, genau so, als hätte das Mitglied sie selbst in Tomorro vorgenommen. Teilen Sie einen Schlüssel niemals in Code, der im Browser ausgeführt wird, in einem öffentlichen Repository oder in einem geteilten Dokument.
Für die Einzelheiten zu Rollen und Berechtigungen: Benutzerrollen und Berechtigungen in Tomorro
Technische Grundlagen
Basis-URL | |
Authentifizierung | Ihr API-Schlüssel, im Header x-api-key |
Format | JSON |
Versionen | Datumsbasierte Versionen, gesendet im Header tomorro-version, zum Beispiel 2025-01-29.alpha. Ohne diesen Header wird die neueste Version verwendet. |
Paginierung | Cursorbasiert: limit (standardmäßig 20, maximal 50), after, before |
Sortierung und Filter | Parameter sort sowie Filter der Form status=in:draft,negotiating oder startAt=gte:2024-01-01 |
Ratenbegrenzung | Zu viele Aufrufe führen zu einer Antwort 429 Too Many Requests: versuchen Sie es nach einer zunehmenden Wartezeit erneut |
Jede Version behält nach ihrer Veröffentlichung dasselbe Verhalten. Wird eine Version als veraltet eingestuft, tragen die Antworten den Header x-api-deprecation-warning und ein Entfernungsdatum im Header sunset ; nach diesem Datum gibt die Version 410 Gone zurück.
In Echtzeit benachrichtigt werden
Anstatt die API regelmäßig aufzurufen, um Änderungen zu erkennen, können Sie einen Webhook empfangen: Tomorro sendet eine HTTPS-Anfrage an die Adresse Ihrer Wahl, sobald ein Ereignis eintritt, zum Beispiel wenn ein Vertrag erstellt oder vollständig unterzeichnet wird.
Die verfügbaren Ereignisse, die Konfiguration und die Prüfung der Echtheit der Anfragen sind hier beschrieben: Webhooks - Dokumentation
Häufige Anwendungsfälle
Verträge aus Ihren Tools erstellen. Ein Nutzer fordert einen Vertrag aus dem CRM oder dem ERP an: die Integration liest die vom Vertragstyp benötigten Felder und erstellt dann in Tomorro einen vorausgefüllten Vertrag, bereit zum Versand zur Unterschrift.
Vertragspartner synchron halten. Lieferanten, Kunden oder Partner, die in Ihrem ERP oder CRM erstellt oder aktualisiert werden, werden in Tomorro erstellt oder aktualisiert, und umgekehrt, wobei die Kennung des Tomorro-Vertragspartners als gemeinsamer Schlüssel dient.
Vertragsdaten in Ihre Tools zurückspielen. Wenn ein Vertrag erstellt oder unterzeichnet wird oder seinen Status ändert, ruft die Integration seine Details ab und aktualisiert den entsprechenden Datensatz in Ihrem CRM, Ihrem ERP oder Ihrem Reporting-Tool.
Unterzeichnete Dokumente archivieren. Wenn ein Vertrag unterzeichnet ist, werden das unterzeichnete PDF und seine Daten in Ihrem Dokumentenmanagement, Ihrem Cloud-Speicher oder Ihrem Data Warehouse abgelegt.
Ihr eigenes Signaturtool verwenden. Verträge, die in einem Drittanbieter-Tool unterzeichnet wurden, werden in Tomorro mit ihren unterzeichneten PDF-Dateien als unterzeichnet markiert.
Arbeitsverträge aus Ihrem HR-System erzeugen. Der Eintritt eines Mitarbeitenden im HR-System erstellt aus einer Vorlage einen Arbeitsvertrag und versendet ihn zur Unterschrift.
Um Ihren Bedarf zu klären, bevor Sie die technische Machbarkeit prüfen: Meinen Integrationsbedarf definieren
Zu beachtende Einschränkungen
Signaturfelder können nicht über die API gesetzt werden. Enthält das Dokument kein Signaturfeld für einen Unterzeichner, schlägt der Versand zur Unterschrift fehl: öffnen Sie den Vertrag in Tomorro, Tab Signatur, um die Felder hinzuzufügen.
Ein Vertrag, der sich bereits im Signaturprozess befindet, unterzeichnet oder abgebrochen ist, kann nicht erneut zur Unterschrift versendet werden.
Von der Vorlage leer gelassene Unterzeichnerplätze werden jeweils auf ihrer eigenen Seite gefüllt: ein interner Platz nimmt ein Tomorro-Mitglied auf, ein externer Platz eine E-Mail-Adresse.
Auswahlfelder erwarten eine der in Tomorro konfigurierten Optionen ; ein unbekannter Wert wird abgelehnt.
Der Filter nach Vertragstyp akzeptiert einen Vertragstyp pro Anfrage: stellen Sie eine Anfrage pro Typ und führen Sie die Ergebnisse auf Ihrer Seite zusammen.
Beim Erstellen eines Mitglieds stehen die Rollen Mitarbeiter, Manager und Admin zur Verfügung.
Eine Abwesenheit kann für jedes Mitglied eingesehen werden, kann aber nur für das Mitglied festgelegt oder beendet werden, dem der API-Schlüssel gehört.
Das Audit-Protokoll ist nur für Administratoren zugänglich, sofern es für Ihre Organisation aktiviert ist.
Einträge benutzerdefinierter Objekte erfordern dynamische Tabellen.
Über die API wird nichts gelöscht: es gibt keinen Aufruf, um einen Vertrag, einen Vertragspartner oder ein Mitglied zu löschen.
Die API aus einem KI-Assistenten steuern
Dieselben Funktionen stehen in natürlicher Sprache in Claude, ChatGPT, Gemini, Copilot oder Dust zur Verfügung, ohne Integrationsprojekt: Tomorro MCP - Einrichtung und Verbindung