---
title: "List folders"
method: POST
path: "/documents/folder-list"
tags: ["Document AI — DMS"]
---

# List folders

`POST /documents/folder-list`

## Request

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

Lists document folder collections (document_folders) only — NOT individual document files.

## Response `200`

Success

- object: List document folders
  - `status` 'success' | 'error', required: HTTP-Level Status
  - `job_id` string, required
  - `message` string: Human-readable status message
  - `pipeline` string: Name of the executed pipeline
  - `operation` string: Executed operation
  - `processing_time` string: Total processing time including queue (format: 123.45ms)
  - `result` object, required: The actual processing result
    - `status` 'completed' | 'failed' | 'timeout': Job-Level Status
    - `message` string: Pipeline-specific status message
    - `duration_ms` string: Pure pipeline processing time in ms
    - `output` object: Output
      - `folders` object[]
      - `total` number
  - `jobs` string: Jobs
  - `templates` string: Templates

## 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)