Ressourcen
Die Referenz beschreibt alle öffentlichen Geschäftsoperationen unter/api/v1: Ordner auflisten und erstellen, Projekte auflisten/erstellen/abrufen, Einheiten auflisten/erstellen/abrufen und Sammelimporte starten/prüfen.
Es gibt aktuell keine hier dokumentierten REST-Endpunkte zum Aktualisieren oder Löschen dieser Datensätze, zum Versenden von E-Mails oder zur Verwaltung aller CRM-Funktionen. Verwenden Sie keine internen Dashboard-Endpunkte als Integrationsvertrag.
Datentypen
- IDs sind UUIDs. Bewahren Sie sie für weitere Aufrufe auf.
- Zeitstempel werden als ISO-8601-Werte übertragen.
- Geld- und Flächenwerte der Einheitenantwort sind Dezimalstrings.
- Optionale Angaben können
nullsein. Ein fehlendesimages-Feld bedeutet, dass Bilder nicht angefordert wurden. - API-Enumwerte bleiben unverändert, auch bei englischer Oberfläche: beispielsweise
frei,reserviertundverkauft.
Spezifikation herunterladen
Die OpenAPI-Datei steht auch am Dashboard unter/api/v1/openapi.json bereit. Beide Fassungen stammen aus derselben Definition; die Docs-Fassung verwendet eine absolute Serveradresse.
Endpunktbeschreibungen und Feldnamen in der generierten Referenz verwenden Englisch. Die begleitenden Anleitungen und Seitentitel stehen auf Deutsch und Englisch zur Verfügung.