Outline · Example Payload

Collectionsexportall

Collections

Collectionsexportall is an example object payload from Outline, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdpathmethodsummarytagsrequestSchema

Example Payload

Raw ↑ 
{
  "operationId": "collectionsExportAll",
  "path": "/collections.export_all",
  "method": "POST",
  "summary": "Export all collections",
  "tags": [
    "Collections"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "format": {
        "type": "string",
        "enum": [
          "outline-markdown",
          "json",
          "html"
        ]
      },
      "includeAttachments": {
        "type": "boolean",
        "description": "Whether to include attachments in the export.",
        "default": true
      },
      "includePrivate": {
        "type": "boolean",
        "description": "Whether to include private collections in the export.",
        "default": true
      }
    }
  }
}