Skip to main content
GET
/
v2
/
documents
/
{documentId}
Get document state
curl --request GET \
  --url https://{instance}.omniapp.co/api/v2/documents/{documentId} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "description": "<string>",
  "queryPresentations": {
    "data": {},
    "order": [
      "<string>"
    ]
  },
  "controls": {
    "data": {},
    "order": [
      "<string>"
    ]
  },
  "settings": {
    "crossfilterEnabled": true,
    "customText": {
      "queryError": "<string>",
      "queryNoResults": "<string>"
    },
    "facetFilters": true,
    "refreshInterval": 123
  },
  "containers": [
    {}
  ]
}

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.

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
​
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.