DEdefaulr
Documents

Export a document.

Changed on

Export a document in Markdown, HTML, PDF, or TextBundle format. The response format is determined by the Accept header (text/markdown, text/html, application/pdf, or application/x-textbundle). Optionally include child documents in the export as a zip file.

post/documents.export

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/documents.export
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

idstring required

Unique identifier for the document. Either the UUID or the urlId is acceptable.

paperSizestring

Paper size for PDF export (e.g., "A4", "Letter")

signedUrlsnumber

How long signed URLs should remain valid for attachment links (in seconds)

includeChildDocumentsboolean

Whether to include child documents in the export. Using this option will always return a zip file.

Response

OK

datastring

The document content in Markdown formatting

Changes

  • 2b998aa571f9Revision changes
    • breaking

      the request property became required

    • info

      api operation id documentsExport was added

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • fdf2ec9c9df4Revision changes
    • info

      added the non-success response with the status