Skip to main content
GET
/
organizations
/
{organizationName}
/
workspaces
/
{workspaceName}
/
documents
/
{documentPath}
Error
A valid request URL is required to generate request examples
{
  "path": "<string>",
  "content": "<string>",
  "type": "workbook",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

​
workspaceName
string
required

The unique identifier of the workspace Standard identifier pattern for resource names

​
documentPath
string
required

The path to the document within the workspace Path pattern supporting slashes, dots, and dashes

Query Parameters

​
checkAdmin
boolean
default:false

Whether to verify admin privileges for the resource

Response

Document updated successfully

Represents a document within a workspace, such as a workbook or dashboard

​
path
string

The file path of the document within the workspace

​
content
string

The content of the document, typically Malloy code or configuration

​
type
enum<string>

The type of document, determining its purpose and behavior

Available options:
workbook,
dashboard
​
createdAt
string<date-time>

ISO 8601 timestamp indicating when the document was created

​
updatedAt
string<date-time>

ISO 8601 timestamp indicating when the document was last modified