Cloudreve API Docs
  1. Workflow
Cloudreve API Docs
  • Site
    • Ping
      GET
    • Get CAPTCHA
      GET
    • Get site settings
      GET
  • Session
    • Token
      • Password sign-in
      • Finish sign-in with 2FA
      • Refresh Token
      • Sign out
    • OpenID
      • Prepare OpenID sign-in
      • Finish OpenID sign-in
      • Unlink OpenID
    • Passkey
      • Prepare Passkey sign-in
      • Finish Passkey sign-in
    • Prepare login
      GET
  • User
    • Passkey
      • Prepare passkey registration
      • Finish passkey registration
      • Delete passkey
    • Setting
      • List available storage policies
      • List available nodes
      • Get preferences
      • Prepare enabling 2FA
      • Update preference setting
      • Update profile pricture
    • Sign up
      POST
    • Send reset password email
      POST
    • Reset password via temp link
      PATCH
    • Get profile picture
      GET
    • Get user
      GET
    • List user's share links
      GET
    • Get storage capacity
      GET
    • Search user
      GET
    • List credit changes
      GET
    • List payments
      GET
  • Callback
    • Complete OneDrive upload
    • Complete COS upload
    • Complete S3 upload
    • Complete OBS upload
  • Workflow
    • Remote Download
      • Create remote download
      • Select files to download
      • Cancel task
    • List tasks
      GET
    • Get task progress
      GET
    • Create archive
      POST
    • Extract archive
      POST
    • Relocate storage policy
      POST
    • Import external files
      POST
  • File
    • Permission
      • Set permission
      • Delete permission setting
    • Upload
      • Create upload session
      • Upload file chunk
      • Delete upload session
    • Pin
      • Pin to sidebar
      • Delete a pin
    • Version
      • Set file version
      • Delete file version
    • Direct Link
      • Create direct links
      • Delete direct link
    • List files
    • List file activities
    • Get file info
    • Get thumbnail URL
    • Update file content
    • Create viewer session
    • Create file
    • Rename file
    • Move or copy files
    • Create download URL
    • Restore from trash bin
    • Delete file
    • Force unlock
    • Patch metadata
    • Mount storage policy
    • Update view setting
  • Share
    • Create share link
    • Edit share link
    • Get share link info
    • List my share links
    • Delete share link
  • VAS
    • Payment
      • Create a payment
      • Get payment status
    • GiftCode
      • Check gift code
      • Redeem gift code
  • Group
    • List groups
  • WebDAV
    • List accounts
    • Create account
    • Update account
    • Delete account
  1. Workflow

List tasks

GET
/workflow
Auth: JWT Required
List all background tasks triggered by current authenticated user.

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Query Params
page_size
integer 
required
>= 10<= 100
Example:
20
category
enum<string> 
required
Select which category of tasks to list.
Allowed values:
generaldownloadingdownloaded
Example:
general
next_page_token
string 
optional
Token for requesting next page. Empty value means requesting the first page.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/workflow?page_size=20&category=general&next_page_token'

Responses

🟢200Success
application/json
Body
data
object (TaskListResponse) 
required
pagination
object 
required
tasks
array[object (TaskResponse) {12}] 
required
code
integer 
required
Response code.
0 - Success.
Default:
0
Example:
0
msg
string 
optional
Human readable error message (if any).
Examples
{
    "code": 0,
    "data": {
        "tasks": [
            {
                "created_at": "2025-04-26T09:57:59+08:00",
                "updated_at": "2025-04-26T09:58:30+08:00",
                "id": "W6AmTK",
                "status": "completed",
                "type": "relocate",
                "summary": {
                    "phase": "finish",
                    "props": {
                        "dst_policy_id": "VecA",
                        "failed": 0,
                        "src_multiple": [
                            "cloudreve://my/1/cloudreve_4.0.0-beta.6_darwin_arm64.tar.gz"
                        ]
                    }
                },
                "duration": 19806,
                "resume_time": 1745632709
            },
            {
                "created_at": "2025-03-16T21:17:50+08:00",
                "updated_at": "2025-03-16T21:18:18+08:00",
                "id": "WqV7iK",
                "status": "completed",
                "type": "create_archive",
                "node": {
                    "id": "xmhb",
                    "name": "Master",
                    "type": "master",
                    "capabilities": "Hg=="
                },
                "summary": {
                    "phase": "upload_archive",
                    "props": {
                        "dst": "cloudreve://my/1/archive2.zip",
                        "failed": 1,
                        "src_multiple": [
                            "cloudreve://my/1/ad"
                        ]
                    }
                },
                "duration": 65,
                "resume_time": 1742131087
            },
            {
                "created_at": "2025-03-16T20:06:18+08:00",
                "updated_at": "2025-03-16T20:06:19+08:00",
                "id": "5EgBfy",
                "status": "error",
                "type": "extract_archive",
                "node": {
                    "id": "xmhb",
                    "name": "Master",
                    "type": "master",
                    "capabilities": "Hg=="
                },
                "summary": {
                    "props": {
                        "dst": "cloudreve://my/0/1/2/3/4/5/6/7/8/9/Q3%E5%A4%B4%E8%84%91%E9%A3%8E%E6%9A%B4",
                        "src": "cloudreve://my/0/1/2/3/4/5/6/7/8/9/Q3%E5%A4%B4%E8%84%91%E9%A3%8E%E6%9A%B4/archive2.zip"
                    }
                },
                "error": "file size 22693848 exceeds the limit 10485760 (non-retryable error)",
                "duration": 13
            }
        ],
        "pagination": {
            "page": 0,
            "page_size": 25,
            "is_cursor": true
        }
    },
    "msg": ""
}
Modified at 2025-06-27 03:12:07
Previous
Cancel task
Next
Get task progress
Built with