Collections

Export a collection

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 body

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

idstring uuid required

Response

Example response

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

Changes

Changed in 2 of the 6 revisions of this API.10

Oct 18, 2024fdf2ec9c9df41See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Jul 6, 20247b33b538cd7d9See the full diff
- ○
  added the optional property data to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property data to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property data to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 404 status
  response-optional-property-added

Full history