---
title: "Get dashboard document"
method: GET
path: "/v1/documents/{documentId}"
tags: ["Documents"]
deprecated: true
---

# Get dashboard document

`GET /v1/documents/{documentId}`

> **Deprecated.**

<Warning>
  **Deprecated** — Removal scheduled for **July 31, 2026**. Use the [Documents v2 API](/api/documents-v2/create-document) instead.
</Warning>

Retrieve dashboard document configuration in a format compatible with PUT for round-trip editing. This endpoint returns all fields needed to modify and update a dashboard document.

**Note:** This endpoint only supports dashboard documents. Workbook-only documents are not supported and will return a `400 Bad Request` error.

## Path parameters

- `documentId` string, required

## Response `200`

Document retrieved successfully

- object
  - `name` string — The name of the document
  - `modelId` string, uuid — The ID of the model the document is built on
  - `facetFilters` boolean — Whether facet filters are enabled for the document
  - `description` string — The description of the document
  - `refreshInterval` integer — Auto-refresh interval in seconds
  - `filterConfig` object — Filter configuration for the document
  - `filterOrder` string[] — Array of filter field names defining the order of filters
  - `queryPresentations` object[] — Array of query presentation objects representing tabs in the document's workbook
    - `name` string — Name of the query tab
    - `query` object — Full OmniQuery object with all query fields
      - `fields` string[] — Array of field names to include in the query
      - `table` string — The table to query from
      - `limit` integer — Maximum number of rows to return
      - `filters` object — Filter conditions for the query
      - `sorts` object[] — Sort order for the query results
      - `modelId` string, uuid — The model ID for the query
    - `chartType` string — Chart type (e.g., "bar", "line", "area", "table")
    - `visualization` object — Visualization configuration
      - `visType` string — The visualization type (e.g., "basic")
      - `config` object — Visualization-specific configuration
      - `fields` string[] — Fields used in the visualization
    - `prefersChart` boolean — Whether the query prefers chart view over table view
    - `id` string, uuid — Query presentation ID
    - `queryIdentifierMapKey` string — Query identifier map key
    - `description` string — Description of the query (if set)
    - `subTitle` string — Subtitle for the query (if set)
    - `topicName` string — Topic name associated with the query (if set)
    - `aiConfig` object — AI configuration for the query
    - `resultConfig` object — Result table configuration

## Other responses

- `400` — Bad Request Possible error messages: - `Analysis documents are not supported`
- `403` — Forbidden. User does not have permission to view the document.
- `404` — Not Found Possible error messages: - `Document with identifier "<documentId>" not found`
- `429` — Too Many Requests - Rate limit exceeded (60 requests/minute)

---

[API](https://skmtc.net/omni/apis/omni-api.md) · [All operations](https://skmtc.net/omni/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omni/omni-api/revisions/6b02f7349d0e/schema)