Read a document body

GEThttps://<your-url>/api/v2/drive-documents/{drive_document}

MCP id drive-documents.showAlso on this path: PATCH Write a document body, DELETE Delete a document body

Returns one document body in the detail view: content as GitHub-Flavored Markdown, plus ?include=content_html for the sanitised-HTML projection that also carries the colours, highlights, alignment and @mentions Markdown cannot express.

Token scope: api:read:project_driveorapi:read:customer_driveorapi:read:organization_driveorapi:read:user_drive
Without it: 403 insufficient-token-scope.
Permission: project_drive::access
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: One body, with the HTML projection alongside it

curl -G \
  'https://<your-url>/api/v2/drive-documents/1' \
  --data-urlencode 'include=content_html' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/drive-documents/1?include=content_html', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/drive-documents/1?include=content_html');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/drive-documents/1?include=content_html',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "drive_item_id": 1,
    "content": "# Kick-off\n\n- [ ] Confirm scope with the client\n- [x] Book the room\n",
    "content_html": "<p>…</p>",
    "created_at": "2026-03-04T09:15:00Z",
    "updated_at": "2026-03-04T09:15:00Z",
    "links": {
      "self": "https://<your-url>/api/v2/work-items/1"
    }
  }
}

Read that projection first if you intend to write the document back, because a Markdown round-trip discards all four. This endpoint first collects any edits still pending in a live editing session, so the body and the ETag describe what has actually been typed; if the collaboration server is unreachable it serves the last stored body instead of failing. The drive item's own metadata (title, folder, tags, owner, effective access) is not repeated here: read it from GET /api/v2/drive-items/{drive_item}, following drive_item_id. There is no soft delete on this resource, so neither trashed nor force is an accepted parameter. The declared permission is project_drive::access; the other three drive prefixes apply by the owning item's owner type, and the per-item rule is what actually decides.

Path parameters

drive_documentintegerRequired

The DriveDocument's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a DriveDocument in the detail view.

Headers

ETag: A strong validator of exactly this representation.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning