Skip to main content
GET
/
api
/
jobs
List jobs with pagination and filtering
curl --request GET \
  --url https://cloud.comfy.org/api/jobs \
  --header 'X-API-Key: <api-key>'
{
  "jobs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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
  }
}

Documentation Index

Fetch the complete documentation index at: https://dripart-changelog-0-18-2.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

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

Query Parameters

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

Available options:
image,
video,
audio
​
sort_by
enum<string>
default:create_time

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

Available options:
create_time,
execution_time
​
sort_order
enum<string>
default:desc

Sort direction (asc = ascending, desc = descending)

Available options:
asc,
desc
​
offset
integer
default:0

Pagination offset (0-based)

Required range: x >= 0
​
limit
integer
default:100

Maximum items per page (1-1000)

Required range: 1 <= x <= 1000

Response

Success - Jobs retrieved

​
jobs
object[]
required

Array of jobs ordered by specified sort field

​
pagination
object
required