v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB

Documents v2

Get draft state

Read the named draft's state. Returns the same DocumentsV2ReadResponse shape as Get document state, and is round-trippable as a PATCH body.

get/v2/documents/{documentId}/draft/{draftId}

Path parameters

documentIdstring required

The published document's URL slug (e.g. abc123) or its canonical workbook UUID.

draftIdstring required

The draft workbook identifier (returned by Create draft and patch document).

Query parameters

prettyboolean

Format response with 2-space indentation for readability. Accepts true, 1, or no value (e.g., ?pretty). Default is compact (single-line) JSON.

Response

Draft state.

namestring required

Document name.

descriptionstring nullable required

Document description.

modelIdstring uuid

The SHARED or SHARED_EXTENSION model the workbook is built on.

workbookModelIdstring uuid

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.

containersobject[]

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.