Read document state
Read the document's published state — draft edits are never surfaced here. When a draft exists, read it via GET /api/v2/documents/{identifier}/draft/{draftIdentifier} before round-tripping the response into a draft PATCH, so you patch the draft's own content rather than published content over it. Returns the full DocumentsV2ReadResponse shape.
The response is structured so a caller can take it verbatim and submit it as the body of the draft PATCH routes. Tiles in queryPresentations.data are keyed by a stable record key (e.g. "1", "2") — the server uses that key to identify existing tiles for updates, so callers do not need to track or send any other identifier. Control IDs and container instanceKey / referenceKey values also round-trip unchanged.
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
Document state. A workbook-only document (no dashboard layout yet) returns only the workbook-scoped fields (name, description, queryPresentations); the dashboard-scoped containers, controls, and settings are omitted until a layout exists. An app document returns the workbook-scoped fields plus an app slice whose url is the app sub-resource, where the app’s HTML and settings are read and written; the slice is withheld when the organization has apps disabled.