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 Fehler.

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.

Kunden

GET/v3/customersv3:customers:readPOST/v3/customersv3:customers:writeGET/v3/customers/{kid}v3:customers:readPATCH/v3/customers/{kid}v3:customers:writeDELETE/v3/customers/{kid}v3:customers:writeGET/v3/customers/{kid}/activitiesv3:activities:readPOST/v3/customers/{kid}/activitiesv3:activities:writeGET/v3/customers/{kid}/addressesv3:customers:readPOST/v3/customers/{kid}/addressesv3:customers:writeGET/v3/customers/{kid}/addresses/{id}v3:customers:readPATCH/v3/customers/{kid}/addresses/{id}v3:customers:writeDELETE/v3/customers/{kid}/addresses/{id}v3:customers:writeGET/v3/customers/{kid}/bankingv3:customers:readPOST/v3/customers/{kid}/bankingv3:customers:writeGET/v3/customers/{kid}/banking/{id}v3:customers:readPATCH/v3/customers/{kid}/banking/{id}v3:customers:writeDELETE/v3/customers/{kid}/banking/{id}v3:customers:writeGET/v3/customers/{kid}/commentsv3:customers:readPOST/v3/customers/{kid}/commentsv3:customers:writeGET/v3/customers/{kid}/comments/{id}v3:customers:readPATCH/v3/customers/{kid}/comments/{id}v3:customers:writeDELETE/v3/customers/{kid}/comments/{id}v3:customers:writeGET/v3/customers/{kid}/contactsv3:customers:readPOST/v3/customers/{kid}/contactsv3:customers:writeGET/v3/customers/{kid}/contacts/{id}v3:customers:readPATCH/v3/customers/{kid}/contacts/{id}v3:customers:writeDELETE/v3/customers/{kid}/contacts/{id}v3:customers:writeGET/v3/customers/{kid}/contractsv3:contracts:readPOST/v3/customers/{kid}/contractsv3:contracts:writeGET/v3/customers/{kid}/damagesv3:damages:readPOST/v3/customers/{kid}/damagesv3:damages:writeGET/v3/customers/{kid}/documentsv3:documents:readPOST/v3/customers/{kid}/documentsv3:documents:writeGET/v3/customers/{kid}/documents/foldersv3:documents:readPOST/v3/customers/{kid}/documents/foldersv3:documents:writePATCH/v3/customers/{kid}/documents/folders/{id}v3:documents:writeDELETE/v3/customers/{kid}/documents/folders/{id}v3:documents:writeGET/v3/customers/{kid}/financesv3:finances:readPOST/v3/customers/{kid}/financesv3:finances:writeGET/v3/customers/{kid}/followersv3:customers:readPOST/v3/customers/{kid}/followersv3:customers:writeDELETE/v3/customers/{kid}/followers/{id}v3:customers:writeGET/v3/customers/{kid}/goalsv3:goals:readPOST/v3/customers/{kid}/goalsv3:goals:writeGET/v3/customers/{kid}/identityv3:customers:readPOST/v3/customers/{kid}/identityv3:customers:writeGET/v3/customers/{kid}/identity/{id}v3:customers:readPATCH/v3/customers/{kid}/identity/{id}v3:customers:writeDELETE/v3/customers/{kid}/identity/{id}v3:customers:writeGET/v3/customers/{kid}/jobsv3:customers:readPOST/v3/customers/{kid}/jobsv3:customers:writeGET/v3/customers/{kid}/jobs/{id}v3:customers:readPATCH/v3/customers/{kid}/jobs/{id}v3:customers:writeDELETE/v3/customers/{kid}/jobs/{id}v3:customers:writeGET/v3/customers/{kid}/linksv3:customers:readPOST/v3/customers/{kid}/linksv3:customers:writeDELETE/v3/customers/{kid}/links/{id}v3:customers:writePOST/v3/customers/{kid}/mergev3:customers:writeGET/v3/customers/{kid}/numbersv3:customers:readPOST/v3/customers/{kid}/numbersv3:customers:writeGET/v3/customers/{kid}/numbers/{id}v3:customers:readPATCH/v3/customers/{kid}/numbers/{id}v3:customers:writeDELETE/v3/customers/{kid}/numbers/{id}v3:customers:writeGET/v3/customers/{kid}/relationsv3:customers:readPOST/v3/customers/{kid}/relationsv3:customers:writeDELETE/v3/customers/{kid}/relations/{id}v3:customers:writeGET/v3/customers/{kid}/tagsv3:customers:readPOST/v3/customers/{kid}/tagsv3:customers:writePATCH/v3/customers/{kid}/tags/{id}v3:customers:writeDELETE/v3/customers/{kid}/tags/{id}v3:customers:write

Verträge

GET/v3/contractsv3:contracts:readPOST/v3/contractsv3:contracts:writeGET/v3/contracts/{id}v3:contracts:readPATCH/v3/contracts/{id}v3:contracts:writeDELETE/v3/contracts/{id}v3:contracts:writeGET/v3/contracts/{id}/commentsv3:contracts:readPOST/v3/contracts/{id}/commentsv3:contracts:writeGET/v3/contracts/{id}/comments/{commentId}v3:contracts:readPATCH/v3/contracts/{id}/comments/{commentId}v3:contracts:writeDELETE/v3/contracts/{id}/comments/{commentId}v3:contracts:writeGET/v3/contracts/{id}/documentsv3:documents:readPOST/v3/contracts/{id}/documentsv3:documents:writeGET/v3/contracts/{id}/documents/{documentId}v3:documents:readPATCH/v3/contracts/{id}/documents/{documentId}v3:documents:writeDELETE/v3/contracts/{id}/documents/{documentId}v3:documents:writeGET/v3/contracts/{id}/documents/foldersv3:documents:readGET/v3/contracts/{id}/followersv3:contracts:readPOST/v3/contracts/{id}/followersv3:contracts:writeDELETE/v3/contracts/{id}/followers/{followerId}v3:contracts:writeGET/v3/contracts/{id}/linksv3:contracts:readPOST/v3/contracts/{id}/linksv3:contracts:writeDELETE/v3/contracts/{id}/links/{linkId}v3:contracts:writeGET/v3/contracts/{id}/personsv3:contracts:readPOST/v3/contracts/{id}/personsv3:contracts:writeDELETE/v3/contracts/{id}/persons/{personId}v3:contracts:writeGET/v3/contracts/{id}/tagsv3:contracts:readPOST/v3/contracts/{id}/tagsv3:contracts:writeDELETE/v3/contracts/{id}/tags/{tagId}v3:contracts:writeGET/v3/contracts/{id}/tariffsv3:contracts:readPOST/v3/contracts/{id}/tariffsv3:contracts:writeDELETE/v3/contracts/{id}/tariffs/{tariffId}v3:contracts:writeGET/v3/contracts/spartenv3:contracts:read · Veraltet

Schäden

GET/v3/damagesv3:damages:readPOST/v3/damagesv3:damages:writeGET/v3/damages/{id}v3:damages:readPATCH/v3/damages/{id}v3:damages:writeDELETE/v3/damages/{id}v3:damages:writeGET/v3/damages/{id}/commentsv3:damages:readPOST/v3/damages/{id}/commentsv3:damages:writeGET/v3/damages/{id}/comments/{commentId}v3:damages:readPATCH/v3/damages/{id}/comments/{commentId}v3:damages:writeDELETE/v3/damages/{id}/comments/{commentId}v3:damages:writeGET/v3/damages/{id}/documentsv3:documents:readPOST/v3/damages/{id}/documentsv3:documents:writeGET/v3/damages/{id}/documents/{documentId}v3:documents:readPATCH/v3/damages/{id}/documents/{documentId}v3:documents:writeDELETE/v3/damages/{id}/documents/{documentId}v3:documents:writeGET/v3/damages/{id}/documents/foldersv3:documents:readGET/v3/damages/{id}/followersv3:damages:readPOST/v3/damages/{id}/followersv3:damages:writeDELETE/v3/damages/{id}/followers/{followerId}v3:damages:writeGET/v3/damages/{id}/linksv3:damages:readPOST/v3/damages/{id}/linksv3:damages:writeDELETE/v3/damages/{id}/links/{linkId}v3:damages:writeGET/v3/damages/{id}/tagsv3:damages:readPOST/v3/damages/{id}/tagsv3:damages:writeDELETE/v3/damages/{id}/tags/{tagId}v3:damages:write

Finanzen

GET/v3/financesv3:finances:readPOST/v3/financesv3:finances:writeGET/v3/finances/{id}v3:finances:readPATCH/v3/finances/{id}v3:finances:writeDELETE/v3/finances/{id}v3:finances:writeGET/v3/finances/{id}/commentsv3:finances:readPOST/v3/finances/{id}/commentsv3:finances:writeGET/v3/finances/{id}/comments/{commentId}v3:finances:readPATCH/v3/finances/{id}/comments/{commentId}v3:finances:writeDELETE/v3/finances/{id}/comments/{commentId}v3:finances:writeGET/v3/finances/{id}/followersv3:finances:readPOST/v3/finances/{id}/followersv3:finances:writeDELETE/v3/finances/{id}/followers/{followerId}v3:finances:writeGET/v3/finances/{id}/linksv3:finances:readPOST/v3/finances/{id}/linksv3:finances:writeDELETE/v3/finances/{id}/links/{linkId}v3:finances:writeGET/v3/finances/{id}/tagsv3:finances:readPOST/v3/finances/{id}/tagsv3:finances:writeDELETE/v3/finances/{id}/tags/{tagId}v3:finances:write

Ziele

GET/v3/goalsv3:goals:readPOST/v3/goalsv3:goals:writeGET/v3/goals/{id}v3:goals:readPATCH/v3/goals/{id}v3:goals:writeDELETE/v3/goals/{id}v3:goals:writeGET/v3/goals/{id}/commentsv3:goals:readPOST/v3/goals/{id}/commentsv3:goals:writeGET/v3/goals/{id}/comments/{commentId}v3:goals:readPATCH/v3/goals/{id}/comments/{commentId}v3:goals:writeDELETE/v3/goals/{id}/comments/{commentId}v3:goals:writeGET/v3/goals/{id}/followersv3:goals:readPOST/v3/goals/{id}/followersv3:goals:writeDELETE/v3/goals/{id}/followers/{followerId}v3:goals:writeGET/v3/goals/{id}/linksv3:goals:readPOST/v3/goals/{id}/linksv3:goals:writeDELETE/v3/goals/{id}/links/{linkId}v3:goals:writeGET/v3/goals/{id}/tagsv3:goals:readPOST/v3/goals/{id}/tagsv3:goals:writeDELETE/v3/goals/{id}/tags/{tagId}v3:goals:write

Aktivitäten

GET/v3/activitiesv3:activities:readPOST/v3/activitiesv3:activities:writeGET/v3/activities/{id}v3:activities:readPATCH/v3/activities/{id}v3:activities:writeDELETE/v3/activities/{id}v3:activities:writeGET/v3/activities/{id}/commentsv3:activities:readPOST/v3/activities/{id}/commentsv3:activities:writeGET/v3/activities/{id}/comments/{commentId}v3:activities:readPATCH/v3/activities/{id}/comments/{commentId}v3:activities:writeDELETE/v3/activities/{id}/comments/{commentId}v3:activities:writeGET/v3/activities/{id}/followersv3:activities:readPOST/v3/activities/{id}/followersv3:activities:writeDELETE/v3/activities/{id}/followers/{followerId}v3:activities:writeGET/v3/activities/{id}/linksv3:activities:readPOST/v3/activities/{id}/linksv3:activities:writeDELETE/v3/activities/{id}/links/{linkId}v3:activities:writeGET/v3/activities/{id}/tagsv3:activities:readPOST/v3/activities/{id}/tagsv3:activities:writeDELETE/v3/activities/{id}/tags/{tagId}v3:activities:write

Dokumente

GET/v3/documentsv3:documents:readPOST/v3/documentsv3:documents:writeGET/v3/documents/{id}v3:documents:readPATCH/v3/documents/{id}v3:documents:writeDELETE/v3/documents/{id}v3:documents:writeGET/v3/documents/{id}/commentsv3:documents:readPOST/v3/documents/{id}/commentsv3:documents:writeGET/v3/documents/{id}/comments/{commentId}v3:documents:readPATCH/v3/documents/{id}/comments/{commentId}v3:documents:writeDELETE/v3/documents/{id}/comments/{commentId}v3:documents:writeGET/v3/documents/{id}/contentv3:documents:readGET/v3/documents/{id}/downloadv3:documents:readGET/v3/documents/{id}/followersv3:documents:readPOST/v3/documents/{id}/followersv3:documents:writeDELETE/v3/documents/{id}/followers/{followerId}v3:documents:writeGET/v3/documents/{id}/linksv3:documents:readPOST/v3/documents/{id}/linksv3:documents:writeDELETE/v3/documents/{id}/links/{linkId}v3:documents:writeGET/v3/documents/{id}/tagsv3:documents:readPOST/v3/documents/{id}/tagsv3:documents:writeDELETE/v3/documents/{id}/tags/{tagId}v3:documents:write

Produktpartner

GET/v3/productsv3:products:readPOST/v3/productsv3:products:writeGET/v3/products/{kid}v3:products:readPATCH/v3/products/{kid}v3:products:writeDELETE/v3/products/{kid}v3:products:writeGET/v3/products/{kid}/activitiesv3:activities:readPOST/v3/products/{kid}/activitiesv3:activities:writeGET/v3/products/{kid}/addressesv3:products:readPOST/v3/products/{kid}/addressesv3:products:writeGET/v3/products/{kid}/addresses/{id}v3:products:readPATCH/v3/products/{kid}/addresses/{id}v3:products:writeDELETE/v3/products/{kid}/addresses/{id}v3:products:writeGET/v3/products/{kid}/bankingv3:products:readPOST/v3/products/{kid}/bankingv3:products:writeGET/v3/products/{kid}/banking/{id}v3:products:readPATCH/v3/products/{kid}/banking/{id}v3:products:writeDELETE/v3/products/{kid}/banking/{id}v3:products:writeGET/v3/products/{kid}/commentsv3:products:readPOST/v3/products/{kid}/commentsv3:products:writeGET/v3/products/{kid}/comments/{id}v3:products:readPATCH/v3/products/{kid}/comments/{id}v3:products:writeDELETE/v3/products/{kid}/comments/{id}v3:products:writeGET/v3/products/{kid}/contact-personsv3:products:readPOST/v3/products/{kid}/contact-personsv3:products:writeGET/v3/products/{kid}/contactsv3:products:readPOST/v3/products/{kid}/contactsv3:products:writeGET/v3/products/{kid}/contacts/{id}v3:products:readPATCH/v3/products/{kid}/contacts/{id}v3:products:writeDELETE/v3/products/{kid}/contacts/{id}v3:products:writeGET/v3/products/{kid}/documentsv3:documents:readPOST/v3/products/{kid}/documentsv3:documents:writeGET/v3/products/{kid}/documents/foldersv3:documents:readPOST/v3/products/{kid}/documents/foldersv3:documents:writePATCH/v3/products/{kid}/documents/folders/{id}v3:documents:writeDELETE/v3/products/{kid}/documents/folders/{id}v3:documents:writeGET/v3/products/{kid}/followersv3:products:readPOST/v3/products/{kid}/followersv3:products:writeDELETE/v3/products/{kid}/followers/{id}v3:products:writeGET/v3/products/{kid}/linksv3:products:readPOST/v3/products/{kid}/linksv3:products:writeDELETE/v3/products/{kid}/links/{id}v3:products:writeGET/v3/products/{kid}/numbersv3:products:readPOST/v3/products/{kid}/numbersv3:products:writeGET/v3/products/{kid}/numbers/{id}v3:products:readPATCH/v3/products/{kid}/numbers/{id}v3:products:writeDELETE/v3/products/{kid}/numbers/{id}v3:products:writeGET/v3/products/{kid}/portalsv3:products:readPOST/v3/products/{kid}/portalsv3:products:writeGET/v3/products/{kid}/tagsv3:products:readPOST/v3/products/{kid}/tagsv3:products:writePATCH/v3/products/{kid}/tags/{id}v3:products:writeDELETE/v3/products/{kid}/tags/{id}v3:products:write

Ansprechpartner

GET/v3/contact-personsv3:products:readPOST/v3/contact-personsv3:products:writeGET/v3/contact-persons/{id}v3:products:readPATCH/v3/contact-persons/{id}v3:products:writeDELETE/v3/contact-persons/{id}v3:products:writeGET/v3/contact-persons/{id}/commentsv3:products:readPOST/v3/contact-persons/{id}/commentsv3:products:writeGET/v3/contact-persons/{id}/comments/{commentId}v3:products:readPATCH/v3/contact-persons/{id}/comments/{commentId}v3:products:writeDELETE/v3/contact-persons/{id}/comments/{commentId}v3:products:writeGET/v3/contact-persons/{id}/followersv3:products:readPOST/v3/contact-persons/{id}/followersv3:products:writeDELETE/v3/contact-persons/{id}/followers/{followerId}v3:products:writeGET/v3/contact-persons/{id}/linksv3:products:readPOST/v3/contact-persons/{id}/linksv3:products:writeDELETE/v3/contact-persons/{id}/links/{linkId}v3:products:writeGET/v3/contact-persons/{id}/tagsv3:products:readPOST/v3/contact-persons/{id}/tagsv3:products:writeDELETE/v3/contact-persons/{id}/tags/{tagId}v3:products:write

Portale

GET/v3/portalsv3:products:readPOST/v3/portalsv3:products:writeGET/v3/portals/{id}v3:products:readPATCH/v3/portals/{id}v3:products:writeDELETE/v3/portals/{id}v3:products:writeGET/v3/portals/{id}/commentsv3:products:readPOST/v3/portals/{id}/commentsv3:products:writeGET/v3/portals/{id}/comments/{commentId}v3:products:readPATCH/v3/portals/{id}/comments/{commentId}v3:products:writeDELETE/v3/portals/{id}/comments/{commentId}v3:products:writeGET/v3/portals/{id}/followersv3:products:readPOST/v3/portals/{id}/followersv3:products:writeDELETE/v3/portals/{id}/followers/{followerId}v3:products:writeGET/v3/portals/{id}/linksv3:products:readPOST/v3/portals/{id}/linksv3:products:writeDELETE/v3/portals/{id}/links/{linkId}v3:products:writeGET/v3/portals/{id}/tagsv3:products:readPOST/v3/portals/{id}/tagsv3:products:writeDELETE/v3/portals/{id}/tags/{tagId}v3:products:write

Benutzer

GET/v3/usersv3:users:readPOST/v3/usersv3:users:writeGET/v3/users/{kid}v3:users:readPATCH/v3/users/{kid}v3:users:writeDELETE/v3/users/{kid}v3:users:writeGET/v3/users/{kid}/activitiesv3:activities:readPOST/v3/users/{kid}/activitiesv3:activities:writeGET/v3/users/{kid}/addressesv3:users:readPOST/v3/users/{kid}/addressesv3:users:writeGET/v3/users/{kid}/addresses/{id}v3:users:readPATCH/v3/users/{kid}/addresses/{id}v3:users:writeDELETE/v3/users/{kid}/addresses/{id}v3:users:writeGET/v3/users/{kid}/bankingv3:users:readPOST/v3/users/{kid}/bankingv3:users:writeGET/v3/users/{kid}/banking/{id}v3:users:readPATCH/v3/users/{kid}/banking/{id}v3:users:writeDELETE/v3/users/{kid}/banking/{id}v3:users:writeGET/v3/users/{kid}/commentsv3:users:readPOST/v3/users/{kid}/commentsv3:users:writeGET/v3/users/{kid}/comments/{id}v3:users:readPATCH/v3/users/{kid}/comments/{id}v3:users:writeDELETE/v3/users/{kid}/comments/{id}v3:users:writeGET/v3/users/{kid}/contactsv3:users:readPOST/v3/users/{kid}/contactsv3:users:writeGET/v3/users/{kid}/contacts/{id}v3:users:readPATCH/v3/users/{kid}/contacts/{id}v3:users:writeDELETE/v3/users/{kid}/contacts/{id}v3:users:writeGET/v3/users/{kid}/documentsv3:documents:readPOST/v3/users/{kid}/documentsv3:documents:writeGET/v3/users/{kid}/documents/foldersv3:documents:readPOST/v3/users/{kid}/documents/foldersv3:documents:writePATCH/v3/users/{kid}/documents/folders/{id}v3:documents:writeDELETE/v3/users/{kid}/documents/folders/{id}v3:documents:writeGET/v3/users/{kid}/followersv3:users:readPOST/v3/users/{kid}/followersv3:users:writeDELETE/v3/users/{kid}/followers/{id}v3:users:writeGET/v3/users/{kid}/identityv3:users:readPOST/v3/users/{kid}/identityv3:users:writeGET/v3/users/{kid}/identity/{id}v3:users:readPATCH/v3/users/{kid}/identity/{id}v3:users:writeDELETE/v3/users/{kid}/identity/{id}v3:users:writeGET/v3/users/{kid}/jobsv3:users:readPOST/v3/users/{kid}/jobsv3:users:writeGET/v3/users/{kid}/jobs/{id}v3:users:readPATCH/v3/users/{kid}/jobs/{id}v3:users:writeDELETE/v3/users/{kid}/jobs/{id}v3:users:writeGET/v3/users/{kid}/linksv3:users:readPOST/v3/users/{kid}/linksv3:users:writeDELETE/v3/users/{kid}/links/{id}v3:users:writeGET/v3/users/{kid}/numbersv3:users:readPOST/v3/users/{kid}/numbersv3:users:writeGET/v3/users/{kid}/numbers/{id}v3:users:readPATCH/v3/users/{kid}/numbers/{id}v3:users:writeDELETE/v3/users/{kid}/numbers/{id}v3:users:writeGET/v3/users/{kid}/tagsv3:users:readPOST/v3/users/{kid}/tagsv3:users:writePATCH/v3/users/{kid}/tags/{id}v3:users:writeDELETE/v3/users/{kid}/tags/{id}v3:users:write

Suche

POST/v3/searchv3:search:read

System

GET/v3/system/relationsv3:system:readGET/v3/system/spartenv3:system:readGET/v3/system/tagsv3:system:readPOST/v3/system/tagsv3:system:writeGET/v3/system/tags/{id}v3:system:readPATCH/v3/system/tags/{id}v3:system:writeDELETE/v3/system/tags/{id}v3:system:write

Posteingang

POST/v3/inbox/documentsv3:inbox:write