Sign in
Documents

Read app content

Alpha. The app sub-resource may change shape without a deprecation cycle while apps mature. The document routes are stable.

Read the published app content: the full HTML plus settings. This is the only endpoint that returns the HTML body; the document GET carries only the app slice. Writes cap the HTML at 2 MiB — apps saved before the cap may read back larger. This reads the published app; an existing draft may have diverged, so read the draft state before building a draft write from this response.

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.

get/api/v2/documents/{identifier}/app

Path parameters

identifierstring required

Document identifier — either the URL slug (e.g. abc123) or the canonical workbook UUID.

Example:abc123

Document identifier — either the URL slug (e.g. abc123) or the canonical workbook UUID.

Query parameters

pretty'0' | '1' | 'true' | 'false'

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 published app content.

htmlstring required

The complete app HTML document.

Changes

Changed in 1 of the 26 revisions of this API.1