Skip to main content
GET
Get document state

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

documentId
string
required

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

Query Parameters

pretty
boolean

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. Round-trippable: submit this verbatim as a draft PATCH body. containers, controls, and settings are dashboard-scoped and omitted for workbook-only documents with no layout yet.

name
string
required

Document name.

Maximum string length: 254
description
string | null
required

Document description.

queryPresentations
object
required
modelId
string<uuid>

The SHARED or SHARED_EXTENSION model the workbook is built on.

workbookModelId
string<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.

controls
object
settings
object
containers
object[]

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.