Endpoints
Vollständige Methoden- und Berechtigungsübersicht der REST API v3, gemeinsam mit der OpenAPI-Datei aus dem aktuellen API-Vertrag erzeugt.
Übersicht
Diese Übersicht enthält 362 Aufrufe an 182 Pfaden. Jede Zeile nennt Methode, Pfad und erforderlichen Scope. Untergeordnete Kommentare, Followers, Tags, Links und Dokumente sind einzeln aufgeführt, soweit die jeweilige Ressource sie unterstützt.
Die OpenAPI-3.1-Datei beschreibt denselben Stand mit Eingaben und Responses und ist ohne Token abrufbar. Datenaufrufe benötigen einen REST-Token; siehe Authentifizierung, Scopes und Fehlercodes.
IDs: {kid} ist die Geschäfts-ID eines Kunden, Produktpartners oder Benutzers; {id} die Datensatz-ID einer eigenständigen Ressource. Weitere Platzhalter wie {commentId} oder {documentId} identifizieren den Eintrag innerhalb der jeweiligen Sub-Ressource. Die IDs werden als positive ganze Zahlen erwartet.
Berechtigungen: Auch unter einem Kunden, Produktpartner oder Benutzer benötigen Dokumente und Aktivitäten ihre eigenen Scopes. write schaltet read nicht zusätzlich frei. Die Suche verwendet trotz POST den Scope v3:search:read und prüft zusätzlich die angefragten Suchindices.
Das Vorhandensein eines Aufrufs in dieser Übersicht bedeutet, dass er implementiert ist. Es ist kein Nachweis eines erfolgreichen Live-Tests.
Ein Klick auf einen Pfad öffnet die Stelle, an der der Aufruf beschrieben ist.