Endpunkt-Referenz

Diese Seite listet jeden öffentlich erreichbaren Endpunkt. Sie ist erzeugt: Pfade, Methoden, Berechtigungen, Parameter und Statuscodes stammen aus dem Backend selbst, nicht aus Handarbeit.

Die maschinenlesbare Fassung mit Rumpfschemata und Antwortformen liegt unter openapi.json (OpenAPI 3.1).

Lesehilfe

• Rolle nennt die schwächste ausreichende Rolle. writer und admin schließen reader ein. Steht dort —, prüft die Operation selbst keine Rolle. Das betrifft vor allem die öffentlichen Links, bei denen der Link die Zugangsentscheidung trägt. Verlassen Sie sich nicht darauf, dass ein — dauerhaft so bleibt.
• Antwort ist der Erfolgsfall. 201 bedeutet: Pfad im Header Location, Rumpf text/plain. → Fehlerbehandlung
• Rumpf sagt, ob ein Anfragerumpf erwartet wird und ob dafür ein Schema hinterlegt ist.
• Alle Pfade beginnen mit https://app.apptivegrid.de.

Veraltete Routen

Einige Routen bedienen nur noch ältere Clients. Sie funktionieren, erscheinen aber nicht mehr in den _links der Antworten und sollten in neuen Integrationen nicht verwendet werden. In den Tabellen sind sie mit veraltet gekennzeichnet.

Stand: Backend 2.4.1348, ausgelesen am 2026-08-30. 160 Endpunkte.

Ein * hinter einem Parameter heißt: verpflichtend.

Metadaten

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	/api/blocks	—	—	—	200
GET	/api/nodeTypes	—	—	—	200
GET	/api/types	—	—	—	200
GET	/api/version	—	—	—	200

Öffentliche Links

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	/api/a/{userId}/{externalHookId} (veraltet)	—	—	—	200
POST	/api/a/{userId}/{externalHookId} (veraltet)	—	—	—	200
GET	/api/a/{userId}/{externalHookId}/{externalHookJson}	—	—	—	200
POST	/api/a/{userId}/{externalHookId}/{externalHookJson}	—	—	—	200
GET	/api/a/{userId}/{externalHookId}/{externalHookJson}/{nestedResourcePath}	—	—	—	200
POST	/api/a/{userId}/{externalHookId}/{externalHookJson}/{nestedResourcePath}	—	—	—	200
PUT	/api/a/{userId}/{externalHookId}/{externalHookJson}/{nestedResourcePath}	—	—	—	200
PATCH	/api/a/{userId}/{externalHookId}/{externalHookJson}/{nestedResourcePath}	—	—	—	200
DELETE	/api/a/{userId}/{externalHookId}/{externalHookJson}/{nestedResourcePath}	—	—	—	200
GET	/api/r/{userId}/{externalHookId} (veraltet)	—	—	—	302
GET	/api/r/{userId}/{externalHookId}/{externalHookJson}	—	—	—	302

Benutzer und API-Schlüssel

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	/api/users/{userId}	reader	—	—	200
GET	…/acceptSharedSpace	admin	urn*, name*, belongsTo, key	—	201
GET	…/accessKeys	admin	pageIndex, pageSize	—	200
POST	…/accessKeys	admin	—	ja, Schema	200
POST	…/copyRemoteSpace	admin	—	ja, Schema	201
POST	…/hooks	admin	—	ja, frei	201
POST	…/SpacePositionChange	admin	—	ja, Schema	200
GET	/api/users/me	—	—	—	302

Flows

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	…/flows	reader	pageIndex, pageSize	—	200
POST	…/flows	admin	—	ja, Schema	201
GET	…/flows/{flowId}	reader	—	—	200
PATCH	…/flows/{flowId}	admin	—	ja, Schema	200
DELETE	…/flows/{flowId}	admin	—	—	200
GET	…/flows/{flowId}/instances	reader	pageIndex, pageSize	—	200
GET	…/flows/{flowId}/instances/{flowInstanceId}	reader	—	—	200
POST	…/flows/{flowId}/instances/{flowInstanceId}/hookUri	reader	—	ja, Schema	200
GET	…/flows/{flowId}/instances/{flowInstanceId}/steps/{steps}/events	reader	pageIndex, pageSize	—	200
POST	…/flows/{flowId}/instances/{flowInstanceId}/steps/{steps}/rerun	reader	—	ja, Schema	200
GET	…/flows/{flowId}/nodes	reader	pageIndex, pageSize	—	200
POST	…/flows/{flowId}/nodes	admin	—	ja, Schema	201
GET	…/flows/{flowId}/nodes/{nodes}	reader	—	—	200
PATCH	…/flows/{flowId}/nodes/{nodes}	writer	—	ja, Schema	200
DELETE	…/flows/{flowId}/nodes/{nodes}	admin	—	—	200
GET	…/flows/{flowId}/nodes/{nodes}/incoming	reader	pageIndex, pageSize	—	200
GET	…/flows/{flowId}/nodes/{nodes}/outgoing	reader	pageIndex, pageSize	—	200
GET	…/flows/{flowId}/nodes/{nodes}/properties	reader	—	—	200
PUT	…/flows/{flowId}/nodes/{nodes}/properties	writer	—	ja, Schema	200
GET	…/flows/{flowId}/nodes/{nodes}/properties/schema	reader	—	—	200
GET	…/flows/{flowId}/nodes/{nodes}/setupBlock	reader	—	—	200
POST	…/flows/{flowId}/removeTransition	admin	—	ja, Schema	201
GET	…/flows/{flowId}/resources	reader	pageIndex, pageSize, types*	—	200
GET	…/flows/{flowId}/transitions	reader	pageIndex, pageSize	—	200
POST	…/flows/{flowId}/transitions	admin	—	ja, Schema	201
GET	…/flows/{flowId}/transitions/{flowTransitionId}	reader	—	—	200
PATCH	…/flows/{flowId}/transitions/{flowTransitionId}	admin	—	ja, Schema	200
DELETE	…/flows/{flowId}/transitions/{flowTransitionId}	admin	—	—	200

Einträge

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	…/spaces/{spaceId}/grids/{gridId}/entities	reader	pageIndex, pageSize, layout, viewId, sorting, filter, compose	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/entities	creator	viewId, layout	ja, Schema	201
GET	…/spaces/{spaceId}/grids/{gridId}/entities/{entityId}	reader	viewId, layout	—	200
PUT	…/spaces/{spaceId}/grids/{gridId}/entities/{entityId}	writer	viewId, layout	ja, Schema	200
DELETE	…/spaces/{spaceId}/grids/{gridId}/entities/{entityId}	writer	—	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/entities/{entityId}/EditLink	admin	—	ja, Schema	201
GET	…/spaces/{spaceId}/grids/{gridId}/entities/{entityId}/events	reader	pageIndex, pageSize	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/entities/{entityId}/update	writer	layout	ja, Schema	200

Felder

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	…/spaces/{spaceId}/grids/{gridId}/fields/{fieldId}	reader	—	—	200
PATCH	…/spaces/{spaceId}/grids/{gridId}/fields/{fieldId}	admin	—	ja, Schema	200
GET	…/spaces/{spaceId}/grids/{gridId}/fields/{fieldId}/collaborators	reader	matching	—	200
GET	…/spaces/{spaceId}/grids/{gridId}/fields/{fieldId}/currencies	reader	—	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/fields/{fieldId}/extractToGrid	admin	createVirtualGrid	—	201
GET	…/spaces/{spaceId}/grids/{gridId}/fields/{fieldId}/query	reader	pageIndex, pageSize, layout, matching, viewId	—	200

Formulare

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	…/spaces/{spaceId}/grids/{gridId}/forms	admin	pageIndex, pageSize	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/forms	admin	—	ja, Schema	201
GET	…/spaces/{spaceId}/grids/{gridId}/forms/{form}	reader	uri	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/forms/{form}	creator	uri	ja, Schema	201
PUT	…/spaces/{spaceId}/grids/{gridId}/forms/{form}	admin	—	ja, frei	200
DELETE	…/spaces/{spaceId}/grids/{gridId}/forms/{form}	admin	—	—	200
GET	…/spaces/{spaceId}/grids/{gridId}/forms/{form}/externalHooks	reader	pageIndex, pageSize	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/forms/{form}/uploadUri	—	—	—	200

Seiten und Blöcke

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	…/spaces/{spaceId}/blocks	reader	pageIndex, pageSize	—	200
POST	…/spaces/{spaceId}/blocks	admin	—	ja, Schema	201
GET	…/spaces/{spaceId}/blocks/{blockId}	reader	—	—	200
PUT	…/spaces/{spaceId}/blocks/{blockId}	admin	—	ja, Schema	200
PATCH	…/spaces/{spaceId}/blocks/{blockId}	admin	—	ja, Schema	200
DELETE	…/spaces/{spaceId}/blocks/{blockId}	admin	—	—	200
POST	…/spaces/{spaceId}/blocks/{blockId}/children	admin	—	ja, Schema	201
GET	…/spaces/{spaceId}/blocks/{blockId}/children/{blockChildId}	reader	—	—	200
PUT	…/spaces/{spaceId}/blocks/{blockId}/children/{blockChildId}	admin	—	ja, Schema	200
PATCH	…/spaces/{spaceId}/blocks/{blockId}/children/{blockChildId}	admin	—	ja, Schema	200
DELETE	…/spaces/{spaceId}/blocks/{blockId}/children/{blockChildId}	admin	—	—	200
GET	…/spaces/{spaceId}/blocks/{blockId}/externalHooks	reader	pageIndex, pageSize	—	200
POST	…/spaces/{spaceId}/blocks/{blockId}/externalHooks	admin	—	ja, Schema	201
POST	…/spaces/{spaceId}/blocks/{blockId}/uploadUri	—	—	—	200

Ansichten

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	…/spaces/{spaceId}/grids/{gridId}/sviews	reader	pageIndex, pageSize, nested	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/sviews	admin	—	ja, Schema	201
GET	…/spaces/{spaceId}/grids/{gridId}/sviews/{sview}	reader	—	—	200
PATCH	…/spaces/{spaceId}/grids/{gridId}/sviews/{sview}	writer	—	ja, Schema	200
DELETE	…/spaces/{spaceId}/grids/{gridId}/sviews/{sview}	admin	—	—	200
GET	…/spaces/{spaceId}/grids/{gridId}/sviews/{sview}/externalHooks	reader	pageIndex, pageSize	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/sviews/{sview}/externalHooks	admin	—	ja, Schema	201
GET	…/spaces/{spaceId}/grids/{gridId}/sviews/{sview}/schema	reader	—	—	200
GET	…/spaces/{spaceId}/grids/{gridId}/sviews/{sview}/shares	admin	pageIndex, pageSize	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/sviews/{sview}/shares	admin	—	ja, Schema	201
GET	…/spaces/{spaceId}/grids/{gridId}/sviews/{sview}/shares/{share}	admin	—	—	200
PUT	…/spaces/{spaceId}/grids/{gridId}/sviews/{sview}/shares/{share}	admin	—	ja, frei	200
DELETE	…/spaces/{spaceId}/grids/{gridId}/sviews/{sview}/shares/{share}	admin	—	—	200
GET	…/spaces/{spaceId}/grids/{gridId}/virtualgrids	reader	pageIndex, pageSize	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/virtualgrids	admin	—	ja, Schema	201

Grids

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	…/spaces/{spaceId}/grids	reader	pageIndex, pageSize, type	—	200
POST	…/spaces/{spaceId}/grids	admin	—	ja, Schema	201
GET	…/spaces/{spaceId}/grids/{gridId}	reader	—	—	200
PUT	…/spaces/{spaceId}/grids/{gridId}	admin	—	ja, Schema	200
PATCH	…/spaces/{spaceId}/grids/{gridId}	admin	—	ja, Schema	200
DELETE	…/spaces/{spaceId}/grids/{gridId}	admin	—	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/AddLink	admin	—	ja, Schema	201
POST	…/spaces/{spaceId}/grids/{gridId}/ColumnAdd	admin	—	ja, Schema	201
POST	…/spaces/{spaceId}/grids/{gridId}/ColumnKeyChange	admin	—	ja, Schema	200
POST	…/spaces/{spaceId}/grids/{gridId}/ColumnRemove	admin	—	ja, Schema	200
POST	…/spaces/{spaceId}/grids/{gridId}/ColumnRename	admin	—	ja, Schema	200
POST	…/spaces/{spaceId}/grids/{gridId}/ColumnTypeChange	admin	—	ja, Schema	200
GET	…/spaces/{spaceId}/grids/{gridId}/csv	—	—	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/EditLink	admin	—	ja, Schema	201
GET	…/spaces/{spaceId}/grids/{gridId}/externalHooks	reader	pageIndex, pageSize	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/extractToGrid	admin	—	ja, Schema	201
POST	…/spaces/{spaceId}/grids/{gridId}/FilterChange	admin	—	ja, Schema	200
GET	…/spaces/{spaceId}/grids/{gridId}/query	reader	pageIndex, pageSize, layout, matching, viewId	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/Rename	admin	—	ja, Schema	200
GET	…/spaces/{spaceId}/grids/{gridId}/schema	reader	—	—	200
GET	…/spaces/{spaceId}/grids/{gridId}/updates	reader	since*	—	200
POST	…/spaces/{spaceId}/grids/{gridId}/viewPositionChange	admin	—	ja, Schema	200

Freigaben und Einladungen

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	…/spaces/{spaceId}/invitations	admin	pageIndex, pageSize	—	200
GET	…/spaces/{spaceId}/invitations/{invitation}	reader	—	—	200
DELETE	…/spaces/{spaceId}/invitations/{invitation}	admin	—	—	200
POST	…/spaces/{spaceId}/invite	admin	—	ja, Schema	200
GET	…/spaces/{spaceId}/shares	admin	pageIndex, pageSize	—	200
POST	…/spaces/{spaceId}/shares	admin	—	ja, Schema	201
GET	…/spaces/{spaceId}/shares/{share}	admin	—	—	200
PUT	…/spaces/{spaceId}/shares/{share}	admin	—	ja, frei	200
DELETE	…/spaces/{spaceId}/shares/{share}	admin	—	—	200

Hooks und externe Links

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	…/spaces/{spaceId}/externalHooks	reader	pageIndex, pageSize	—	200
GET	…/spaces/{spaceId}/externalHooks/{externalHookInternalId}	reader	—	—	200
PATCH	…/spaces/{spaceId}/externalHooks/{externalHookInternalId}	admin	—	ja, Schema	200
DELETE	…/spaces/{spaceId}/externalHooks/{externalHookInternalId}	admin	—	—	200
POST	…/spaces/{spaceId}/externalHooks/{externalHookInternalId}/editEntityUri	reader	—	ja, Schema	200
GET	…/spaces/{spaceId}/hooks	reader	pageIndex, pageSize	—	200
POST	…/spaces/{spaceId}/hooks	admin	—	ja, Schema	201
GET	…/spaces/{spaceId}/hooks/{hook}	reader	—	—	200
PUT	…/spaces/{spaceId}/hooks/{hook}	admin	—	ja, Schema	200
DELETE	…/spaces/{spaceId}/hooks/{hook}	admin	—	—	200
POST	…/spaces/{spaceId}/hooks/{hook}/test	admin	—	—	200

Spaces

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	…/spaces	reader	pageIndex, pageSize, matching	—	200
POST	…/spaces	admin	—	ja, Schema	201
GET	…/spaces/{spaceId}	reader	—	—	200
PATCH	…/spaces/{spaceId}	admin	—	ja, Schema	200
DELETE	…/spaces/{spaceId}	admin	—	—	200
POST	…/spaces/{spaceId}/copy	reader	—	ja, Schema	201
GET	…/spaces/{spaceId}/flows	reader	pageIndex, pageSize	—	200
POST	…/spaces/{spaceId}/flows	admin	—	ja, Schema	201
POST	…/spaces/{spaceId}/PersistentGridPositionChange	admin	—	ja, Schema	200
POST	…/spaces/{spaceId}/Rename	admin	—	ja, frei	200
GET	…/spaces/{spaceId}/resources	reader	pageIndex, pageSize, types*	—	200
POST	…/spaces/{spaceId}/uploadCSV	admin	—	ja, Schema	201
POST	…/spaces/{spaceId}/uploadUri	—	—	—	200
POST	…/spaces/{spaceId}/VirtualGridPositionChange	admin	—	ja, Schema	200

Sonstiges

Methode	Pfad	Rolle	Query	Rumpf	Antwort
GET	…/accessKeys/{accessCredentialsId}	admin	—	—	200
DELETE	…/accessKeys/{accessCredentialsId}	admin	—	—	200