Skip to main content
GET
/
organizations
/
{organizationName}
/
workspaces
/
{workspaceName}
/
documents
/
{documentPath}
Get document details
curl --request GET \
  --url https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/workspaces/{workspaceName}/documents/{documentPath} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/workspaces/{workspaceName}/documents/{documentPath}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/workspaces/{workspaceName}/documents/{documentPath}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/workspaces/{workspaceName}/documents/{documentPath}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/workspaces/{workspaceName}/documents/{documentPath}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/workspaces/{workspaceName}/documents/{documentPath}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/workspaces/{workspaceName}/documents/{documentPath}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "path": "<string>",
  "content": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "modifiedBy": "<string>",
  "metadata": {}
}
{
"code": "<string>",
"message": "<string>"
}
{
"code": "<string>",
"message": "<string>"
}
{
"code": "<string>",
"message": "<string>"
}
{
"code": "<string>",
"message": "<string>"
}

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

Pattern: ^[a-zA-Z0-9_-]+$
workspaceName
string
required

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

Pattern: ^[a-zA-Z0-9_-]+$
documentPath
string
required

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

Pattern: ^[a-zA-Z0-9_/.-]+$

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

Pattern: ^[a-zA-Z0-9_/.-]+$
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,
modeling_chat,
data_chat,
agent_report
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

modifiedBy
string | null

The userId of the user who last modified this document

metadata
object | null

Optional JSON metadata associated with the document (e.g. title, tags)