DEdefaulr
Collections

Export a collection

Changed on

Triggers a bulk export of the collection in markdown format and their attachments. If documents are nested then they will be nested in folders inside the zip file. The endpoint returns a FileOperation that can be queried to track the progress of the export and get the url for the final file.

post/collections.export

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/collections.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

format'outline-markdown' | 'json' | 'html' | 'okf'
idstring uuid required

Response

OK

Example response

{
  "data": {
    "fileOperation": {
      "type": "export",
      "format": "outline-markdown",
      "state": "complete",
      "size": "2048",
      "user": {
        "name": "Jane Doe"
      }
    }
  }
}

Changes