---
title: "Get document"
method: GET
path: "/api/v1/documents/{identifier}"
tags: ["Documents"]
---

# Get document

`GET /api/v1/documents/{identifier}`

Retrieves a document's configuration in a format compatible with PUT for round-trip editing. GET a document, modify the response, and PUT it back to update. Only dashboard documents are supported; analysis documents return 400.

## Path parameters

- `identifier` string, required — Document identifier (either document ID or identifier slug)

## Response `200`

Document details

- DocumentsGetResponse
  - `description` string, nullable — Document description
  - `documentMetadata` unknown
  - `facetFilters` boolean, required — Whether facet filters are enabled
  - `filterConfig` unknown
  - `filterOrder` string[], required — Order of filters
  - `modelId` string, required — Model ID
  - `name` string, required — Document name
  - `queryPresentations` unknown[], required — Query presentations
    - unknown
  - `refreshInterval` number, nullable, required — Auto-refresh interval in seconds

## Other responses

- `400` — Analysis documents are not supported
- `401` — Authentication required
- `403` — Insufficient permissions to view the document
- `404` — Document not found

---

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