Get document details
Retrieves detailed information about a specific document including content, metadata, and configuration details.
Authorization: Requires read access to the document.
Parameters: The checkAdmin parameter can be used to verify admin privileges.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the organization Standard identifier pattern for resource names
^[a-zA-Z0-9_ -]+$The unique identifier of the workspace
Workspace name pattern. Allows any character except / (would split the FGA resource path — see ResourceIdentifier.parseFromFga) and * (FGA wildcard). 1-63 chars.
^(?!.*\*)(?!.*[/]).{1,63}$The path to the document within the workspace Document path. Permits alphanumerics, spaces, ASCII hyphen, Unicode en-dash/em-dash (U+2013/U+2014), and common title punctuation (& : , ' + ? ! ( ) $ ^). Bans path traversal (..). Length capped at 255 to match the underlying varchar(255) storage column. % is deliberately excluded because @InitBinder decodes %2F → / in path variables to fix encoded-slash routing, which would collide with any path that legitimately contained '%2F'.
255^(?!.*\.\.)[a-zA-Z0-9_/. \-&:,'+?!()$^–—]+$Query Parameters
Whether to verify admin privileges for the resource
Response
Document updated successfully
Represents a document within a workspace, such as a workbook or dashboard
The file path of the document within the workspace
255^(?!.*\.\.)[a-zA-Z0-9_/. \-&:,'+?!()$^–—]+$The content of the document, typically Malloy code or configuration
The type of document, determining its purpose and behavior
workbook, dashboard, modeling_chat, data_chat, agent_report, agent_modeling_file, agent_html_report, draft_agent_html_report, draft_agent_report, draft_package, model_summary ISO 8601 timestamp indicating when the document was created
ISO 8601 timestamp indicating when the document was last modified
The userId of the user who last modified this document
Optional JSON metadata associated with the document (e.g. title, tags)