For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Integration Example (PSA)
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
      • GETReturns all documents.
      • POSTCreates a new document.
      • POSTRestores the document with the specified id from the trash.
      • GETReturns the document with the specified id.
      • PUTUpdates the document with the specified id.
      • DELDeletes the document with the specified id.
      • GETReturns the content of the current version of the document with the specified id.
      • PUTUpdates the content of the document with the specified id.
      • POSTAdds a list of document contributors to the document with the specified id.
      • PUTUpdates the access of a document contributor with the specified id to a document.
      • DELDeletes the document contributor with the specified id from a document.
      • POSTDuplicates the document with the specified id.
      • POSTAdds a list of document teams to a document with the specified id.
      • PUTUpdates the document team with the specified id.
      • DELDeletes the document team with the specified id from a document.
      • GETReturns all documents that belong to the document space with the specified id.
      • GETReturns all deleted documents of the document space with the specified id.
      • GETReturns the requesting user's private documents.
      • GETReturns the requesting user's private trashed documents.
      • GETReturns all documents that were shared with the requesting user.
      • GETRetrieves all documents for a project.
      • GETRetrieves all trashed documents for a project.
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Workflows Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceDocuments

Returns the content of the current version of the document with the specified id.

GET
https://api.awork.com/api/v1/documents/:documentId/content
GET
/api/v1/documents/:documentId/content
$curl https://api.awork.com/api/v1/documents/documentId/content \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1"<h1>Project Plan</h1><p>This document outlines the project plan for Q3 2024, including milestones, deliverables, and resource allocation.</p><ul><li>Milestone 1: Requirements Gathering - Completed</li><li>Milestone 2: Design Phase - In Progress</li><li>Milestone 3: Development - Scheduled to start July 1, 2024</li></ul><p>For more details, refer to the attached schedule and resource plan.</p>"
<Check title="Required Permissions" icon="key">The user must have at least `read` permissions for the specified document.</Check>
Was this page helpful?
Previous

Updates the content of the document with the specified id.

Next
Built with
Required Permissions
The user must have at least read permissions for the specified document.

Authentication

AuthorizationBearer

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

Path parameters

documentIdstringRequiredformat: "uuid"
The id of the document.

Query parameters

streamAsFilebooleanOptionalDefaults to false

Whether to stream the content as a file. By default, the document’s content is returned in a model containing a property Content holding the content as a string.

formatstringOptionalDefaults to html

The response format. Supported values are html and markdown.

Response

OK

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error