v6

latestOpenAPI 3.0.0raw.githubusercontent.com2024-10-187525179.6 KB
Collections

Export all collections

Triggers a bulk export of all documents in and their attachments. The endpoint returns a FileOperation that can be queried through the fileOperations endpoint to track the progress of the export and get the url for the final file.

post/collections.export_all

Request body

format'outline-markdown' | 'json' | 'html'

Response

OK

Example response

{
  "data": {
    "fileOperation": {
      "type": "export",
      "state": "complete",
      "collection": {
        "name": "Human Resources",
        "index": "P",
        "color": "#123123"
      },
      "user": {
        "name": "Jane Doe"
      },
      "size": 2048
    }
  }
}