List jobs with pagination and filtering

Retrieve a paginated list of jobs for the authenticated user. Returns lightweight job data optimized for list views. Workflow and full outputs are excluded to reduce payload size.

GET /api/jobs

List jobs with pagination and filtering

cURL

curl --request GET \
  --url https://cloud.comfy.org/api/jobs \
  --header 'X-API-Key: <api-key>'

200

{
  "jobs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "create_time": 123,
      "execution_error": {
        "node_id": "<string>",
        "node_type": "<string>",
        "exception_message": "<string>",
        "exception_type": "<string>",
        "traceback": [
          "<string>"
        ],
        "current_inputs": {},
        "current_outputs": {}
      },
      "preview_output": {},
      "outputs_count": 123,
      "workflow_id": "<string>",
      "execution_start_time": 123,
      "execution_end_time": 123
    }
  ],
  "pagination": {
    "offset": 1,
    "limit": 2,
    "total": 1,
    "has_more": true
  }
}

授权

X-API-Key · string · header · 必填

API key authentication. Generate an API key from your account settings at https://comfy.org/account. Pass the key in the X-API-Key header.

查询参数

status · string

Filter by one or more statuses (comma-separated). If not provided, returns all jobs.

workflow_id · string

Filter by workflow ID (exact match)

output_type · enum<string>

Filter by output media type (only applies to completed jobs with outputs)

可用选项: image, video, audio

sort_by · enum<string> · 默认值: create_time

Field to sort by (create_time = when job was submitted, execution_time = how long workflow took to run)

可用选项: create_time, execution_time

sort_order · enum<string> · 默认值: desc

Sort direction (asc = ascending, desc = descending)

可用选项: asc, desc

offset · integer · 默认值: 0

Pagination offset (0-based)

必填范围: x >= 0

limit · integer · 默认值: 100

Maximum items per page (1-1000)

必填范围: 1 <= x <= 1000

响应

200

application/json

Success - Jobs retrieved

jobs · object[] · 必填

Array of jobs ordered by specified sort field

显示 子属性

pagination · object · 必填

显示 子属性