---
title: "Export document list"
method: POST
path: "/documents/documents-export"
tags: ["Document AI — DMS"]
---

# Export document list

`POST /documents/documents-export`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/documents/documents-export`
- Auth: HTTP bearer

Export Documents Bulk export documents as ZIP archive. Options: - Specific POFIDs - All from workspace

## Request body

- object
  - `selected_pofids` string[], required: JSON array of POFIDs to export.
  - `export_format` 'excel' | 'xlsx' | 'csv' | 'json' | 'pdf' | 'zip', required: Export format: excel/xlsx (spreadsheet), csv, json, pdf. Legacy alias zip maps to json bundle with original files (use archive_format for zip/7z).
  - `selected_fields` string[], required: JSON array of field names to export (e.g. ['file_name', 'created_datetime', 'file_size']).
  - `field_order` string[]: Optional column order for the export.
  - `include_original_files` boolean: Include original files in the export bundle (typically with export_format=json or zip alias).
  - `include_ocr_text` boolean: Include OCR-extracted text in the export.
  - `include_ocr_bounding_boxes` boolean: Include OCR bounding boxes (position data) in the export.
  - `archive_format` 'zip' | '7z': Archive format for file exports (zip or 7z).
  - `excel_options` object: Optional Excel-specific settings (column width, header formatting etc.).
  - `filename_pattern` string: Optional naming schema for original files in the ZIP/7z bundle. Use {field_key} tokens plus separators _ - . and space, e.g. {date_issued}_{document_number}_{publisher_name}_{document_type}. Empty keeps the original filename (DMS file_name). Applied only when original files are included. Invalid patterns return HTTP 400 INVALID_FILENAME_PATTERN.

## Response `200`

Success

- object: Dokumentenliste exportieren
  - `status` 'success' | 'error', required: HTTP-Level Status
  - `job_id` string, required
  - `message` string: Menschenlesbare Statusmeldung
  - `pipeline` string
  - `operation` string: Ausgefuehrte Operation
  - `processing_time` string: Gesamte Verarbeitungszeit inkl. Queue (Format: 123.45ms)
  - `result` object, required: Das eigentliche Verarbeitungsergebnis
    - `status` 'completed' | 'failed' | 'timeout': Job-Level Status
    - `message` string: Pipeline-spezifische Statusmeldung
    - `duration_ms` string: Reine Pipeline-Verarbeitungszeit in ms
    - `output_files` object
    - `output` object
      - `total_exported` number
      - `format` string

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)