Skip to main content
GET
/
v1
/
workflow
List Workflows
curl --request GET \
  --url https://api.comfycontrol.app/v1/workflow \
  --header 'Authorization: Bearer <token>'
{
  "401": {},
  "workflows": [
    {}
  ],
  "total": 123,
  "workflows[].id": "<string>",
  "workflows[].name": "<string>",
  "workflows[].status": "<string>",
  "workflows[].tags": [
    "<string>"
  ],
  "workflows[].created_at": "<string>",
  "workflows[].updated_at": "<string>",
  "workflows[].started_at": "<string>",
  "workflows[].completed_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.comfycontrol.app/llms.txt

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

​
Overview

Retrieve all workflows created by your account with pagination support. Results are ordered by creation date (newest first).

​
Query Parameters

​
page
integer
Page number to retrieve (default: 1, minimum: 1).
​
per_page
integer
Number of workflows per page (default: 10, minimum: 1, maximum: 100).
​
status
string
Filter workflows by status (possible values: “completed”, “running”, “queued”, “failed”, “cancelled”)

​
Response

​
workflows
array
required
Array of workflow objects.
​
total
integer
required
Total number of workflows across all pages.

​
Workflow Object

​
workflows[].id
string
required
Unique identifier (UUID) for the workflow.
​
workflows[].name
string
required
The workflow’s name.
​
workflows[].status
string
required
Current status of the workflow.Possible values: accepted, uploaded, queued, running, completed, cancelled, invalid, failed
​
workflows[].tags
string[]
required
Array of tags associated with the workflow.
​
workflows[].created_at
string
required
ISO 8601 timestamp when the workflow was created.
​
workflows[].updated_at
string
required
ISO 8601 timestamp when the workflow was last updated.
​
workflows[].started_at
string
ISO 8601 timestamp when execution started (null if not yet started).
​
workflows[].completed_at
string
ISO 8601 timestamp when execution completed (null if not yet completed).

​
Example Response

{
  "workflows": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Text to Image Generation",
      "status": "completed",
      "tags": ["production", "text2img"],
      "created_at": "2024-01-15T14:30:00Z",
      "updated_at": "2024-01-15T14:32:15Z",
      "started_at": "2024-01-15T14:30:05Z",
      "completed_at": "2024-01-15T14:32:15Z"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Image Upscaling",
      "status": "running",
      "tags": ["upscale"],
      "created_at": "2024-01-15T14:20:00Z",
      "updated_at": "2024-01-15T14:25:30Z",
      "started_at": "2024-01-15T14:20:15Z",
      "completed_at": null
    },
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "name": "Video Processing",
      "status": "queued",
      "tags": ["video", "batch"],
      "created_at": "2024-01-15T14:10:00Z",
      "updated_at": "2024-01-15T14:10:00Z",
      "started_at": null,
      "completed_at": null
    }
  ],
  "total": 127
}

​
Error Responses

​
401
error
Unauthorized - invalid or missing authentication token.

​
Notes

  • Results are ordered by creation date (newest first)
  • The total field indicates the total count across all pages
  • All workflow statuses are included in the list
  • Use the workflow ID to fetch detailed information or subscribe to updates