Get document state
Retrieve the document’s published state. The response can be used as-is as the request body in a call to the Patch draft API.
If documentId names a draft instead of a published document, the response also includes draftOf.identifier, the published document the draft belongs to. To read a draft’s state, use Get draft state, which returns the same draftOf field. To read an app document’s HTML, use Read app content.
Query tiles
Tiles inqueryPresentations.data are keyed by a stable record key (e.g. "1", "2"); the server uses that key to identify existing tiles on a later patch, so you never need to track any other identifier. Control IDs and container instanceKey / referenceKey values also round-trip unchanged.
Workbook-only documents
Workbook-only documents return only the workbook-scoped fields (name, description, queryPresentations); the dashboard-scoped containers, controls, and settings are omitted until a layout exists.
App documents
App documents return the workbook-scoped fields plus anapp property whose url is the app sub-resource, where the app’s HTML and settings are read and written — the document body itself doesn’t include anything app-scoped. The app property is omitted (the document reads as workbook-only) when apps are disabled for the organization.Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The document's URL slug (e.g. abc123) or its canonical workbook UUID. Also accepts a draft identifier, in which case the response is the draft's state with draftOf.identifier naming the published document.
Query Parameters
Format response with 2-space indentation for readability. Accepts true, 1, or no value (e.g., ?pretty). Default is compact (single-line) JSON.
Response
Document state.
Current document or draft state.
Submit this as-is as a draft PATCH body. containers, controls, and settings are dashboard-scoped and omitted for workbook-only documents with no layout yet. An app document returns the workbook-scoped fields plus an app property; the app property is omitted when the organization has apps disabled.
Document name.
254Document description.
The SHARED or SHARED_EXTENSION model the workbook is built on.
The workbook-layer model ID. Each document has its own workbook model for document-specific fields and calculations. For drafts, this returns the draft's workbook model ID, not the published document's.
Container layout array (grid / stack / page / reference containers, recursively nested). On a patch, when present this fully replaces the existing layout. The server validates the full structure on apply; container instanceKey / referenceKey values round-trip unchanged. See the dashboard layout reference for the complete grammar.
Present only on an app document. The app's HTML and settings live at the url sub-resource — the document body itself carries nothing app-scoped. Omitted entirely (the document reads as workbook-only) when the organization has apps disabled.
Present only when the requested identifier names a draft. Omitted for published-document reads.

