Manual · 10
Apps endpoints
See Apps for the functional details. All endpoints except GET /apps/mine are admin-only.
| Method | Path | Description |
|---|---|---|
| GET | /apps |
List apps |
| GET | /apps/mine |
Published apps the caller may open (app users and viewers too) |
| POST | /apps |
Create an app (name, optional slug, description, access, definition – or template crud/form/dashboard with table (table ID) and lang for the texts, see templates) |
| POST | /apps/import |
Create an app from an export file |
| GET | /apps/{id} |
App with its draft (definition) |
| PATCH | /apps/{id} |
Change settings or the draft |
| DELETE | /apps/{id} |
Delete an app (with versions and grants) |
| POST | /apps/{id}/publish |
Publish the draft as the next version |
| POST | /apps/{id}/unpublish |
Take offline |
| GET | /apps/{id}/versions |
Published versions |
| POST | /apps/{id}/versions/{version}/restore |
Restore a version as the draft |
| GET | /apps/{id}/export |
Draft as a file |
| GET | /apps/{id}/access |
Granted users and groups |
| PUT | /apps/{id}/access |
Set grants ({"users": [...], "groups": [...]}) |
| GET | /apps/{id}/icon |
Icon as PNG (own or initial) |
| PUT | /apps/{id}/icon |
Set the own icon (body: image) |
| DELETE | /apps/{id}/icon |
Remove the own icon |
Invalid definitions are answered with 400 invalid_app_definition, naming the location (e.g. pages[0].elements[2]: outside the grid). A taken address gives 409 app_slug_taken. Templates answer problems with 400 and app_template_unknown, app_template_table_required, app_template_table_unknown, app_template_table_readonly (no single primary key) or app_template_no_fields.
REST sources (admin-only)
| Method | Path | Description |
|---|---|---|
| GET | /app-sources |
List REST sources (without header values) |
| POST | /app-sources |
Create a source (name, base_url, headers) |
| PATCH | /app-sources/{id} |
Change a source (headers replaces all headers) |
| DELETE | /app-sources/{id} |
Delete a source |
Runtime of an app
Outside /api/v1 – the app in the browser calls it. Login via session (apps with login) or none (public apps); ?draft=1 admins only.
| Method | Path | Description |
|---|---|---|
| GET | /app/<slug>/_api/app |
Definition for the browser (queries only with name, type and parameters, without workflows) |
| POST | /app/<slug>/_api/query/<name> |
Run a query ({"params": {…}, "offset", "limit", "sort"}; upload queries: multipart/form-data with params (JSON) and file, at most 50 MB) |
| GET | /app/<slug>/_api/file/<query>/<file-id>[/thumbnail] |
a file of an attachment column (or its thumbnail) – only when the named reading query (list, record, workflow) reaches the file’s table, with a read grant on exactly that table; otherwise 404 |
| GET | /app/<slug>/manifest.webmanifest |
Manifest of the PWA |
| GET | /app/<slug>/icon-192.png, icon-512.png |
Icons of the PWA |
| GET | /app/<slug>/sw.js |
Service worker |