documents

Returns the current document content.

Changed on

Returns HTML by default. Use format=markdown for readable Markdown with hidden editor metadata. Use streamAsFile to receive file content. <Check title="Required Permissions" icon="key">The user must have at least read permission for the specified document.</Check>

get/documents/{documentId}/content

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/documents/{documentId}/content
  • Auth: HTTP bearer

Path parameters

documentIdstring uuid required

The id of the document.

Query parameters

streamAsFileboolean

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.

formatstring

The response format. Supported values are html and markdown.

Response

OK

string required

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id GetDocumentContentByDocumentId removed and replaced with documents_GetDocumentContentByDocumentId