Die Structure API liefert dir die Struktur und Konfiguration deines Joinpoints Accounts – also genau jene Informationen, die du für dynamische Integrationen brauchst: Speicherorte, Ordner, Pipelines, Listen, Templates und Felddefinitionen.
In Joinpoints hängen viele API-Requests von IDs ab (z. B. Template ID, Feld-IDs, Options-IDs, Phasen-IDs). Diese IDs sind in der UI sichtbar, aber in Integrationen holt man sie typischerweise automatisiert über die Structure API.
Die folgenden Typen werden in getJoinpointTemplateMeta pro Feld zurückgeliefert. Sie beschreiben, welches Format Joinpoints bei Befehlen wie create und update erwartet.
default – normaler Stringphone_number – String (Telefonnummer)link – String (URL)multi_text – mehrzeiliger Stringboolean – String mit true / falsegender – String mit male / femaledate – String im Format yyyy-mm-dd hh::ss.sssemail – String (E-Mail)number – Dezimalzahl (float)consecutive_number – Dezimalzahl (float), fortlaufende Nummerpercent – Dezimalzahl (float), Anzeige als Prozentamount – Dezimalzahl (float), Anzeige als Währungsbetragduration_hours – Dezimalzahl (float), Anzeige als Stunden/DauerRelationstypen verknüpfen ein Feld mit anderen Joinpoints (oder Usern). Je nach Relation ist ein eigener Update-Befehl notwendig.
status – ID als Integer (Optionen werden im Template-Meta mitgeliefert)single_jp – ID als Integer des verbundenen Joinpointsdropdown_jp – ID als Integer, technisch wie single_jp, andere Darstellung in Joinpointsmulti_jp – Verbindung zu mehreren Joinpointsuser_jp – ID als Integer eines Users (User ist ebenfalls ein Joinpoint und kann z. B. über E-Mail + simpleType user gefunden werden)customer – ID als Integer (Kontakt: company oder contact)multi_jp wird in der Joinpoints API der Befehl
updateJoinpointRelation verwendet, um Relationen hinzuzufügen oder zu entfernen.
phase kann nicht über create oder update gesetzt werden.
Die „API commands“ unten enthalten die technische Referenz für alle Structure-Endpoints inklusive Response-Schemas.
