Returns the current document content.

GET

https://api.awork.com/api/v1/documents/:documentId/content

Returns the current version as HTML by default. Use format=markdown for canonical Markdown, or streamAsFile to receive file content.

Required Permissions

The user must have at least read permission for the specified document.

Returns the current version as HTML by default. Use `format=markdown` for canonical Markdown, or `streamAsFile` to receive file content. <Check title="Required Permissions" icon="key">The user must have at least `read` permission for the specified document.</Check>

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

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error