v1
latestOpenAPI 3.1.02026-07-2618690613.4 KBDocuments
Get dashboard document
<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.
get/v1/documents/{documentId}
Path parameters
documentIdstring required
The document identifier. To retrieve the ID, navigate to File > Document settings in the document and then click Settings. The Identifier field contains the document ID.
Response
Document retrieved successfully