Read app content on the main draft
Alpha. The app sub-resource may change shape without a deprecation cycle while apps mature. The document routes are stable.
Read the app content on the document's main (non-branch) draft — the read counterpart of PUT …/draft/app, so a caller in the draft-then-publish loop never has to track the draft identifier. Unlike the PUT sibling this never mints a draft: a document with no main draft is a 404. Writes cap the HTML at 2 MiB — apps saved before the cap may read back larger, and a body over the cap is rejected on the way back in.
A draft with no app is a 404 — including a draft that carries a dashboard, which can never carry an app.
A document carries at most one of a dashboard or an app — never both; workbook-only is valid. The app HTML and settings live only at the app sub-resource routes; the document read carries an app slice pointing here, and the whole-document PATCH accepts that slice back only as it was read.
Path parameters
Document identifier — either the URL slug (e.g. abc123) or the canonical workbook UUID.
Document identifier — either the URL slug (e.g. abc123) or the canonical workbook UUID.
Query parameters
Set true or 1 to pretty-print (2-space indent) the response; false / 0 (the default) is compact. Key ordering is deterministic regardless.
Set true or 1 to pretty-print (2-space indent) the response; false / 0 (the default) is compact. Key ordering is deterministic regardless.
Response
The main draft's app content.
Changes
Changed in 1 of the 26 revisions of this API.1
- ○
endpoint added
endpoint-added
- ○