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

# List Workflows

> Retrieve a paginated list of your workflows

## Overview

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

## Query Parameters

<ParamField query="page" type="integer">
  Page number to retrieve (default: 1, minimum: 1).
</ParamField>

<ParamField query="per_page" type="integer">
  Number of workflows per page (default: 10, minimum: 1, maximum: 100).
</ParamField>

<ParamField query="status" type="string">
  Filter workflows by status (possible values: "completed", "running", "queued", "failed", "cancelled")
</ParamField>

## Response

<ResponseField name="workflows" type="array" required>
  Array of workflow objects.
</ResponseField>

<ResponseField name="total" type="integer" required>
  Total number of workflows across all pages.
</ResponseField>

### Workflow Object

<ResponseField name="workflows[].id" type="string" required>
  Unique identifier (UUID) for the workflow.
</ResponseField>

<ResponseField name="workflows[].name" type="string" required>
  The workflow's name.
</ResponseField>

<ResponseField name="workflows[].status" type="string" required>
  Current status of the workflow.

  Possible values: `accepted`, `uploaded`, `queued`, `running`, `completed`, `cancelled`, `invalid`, `failed`
</ResponseField>

<ResponseField name="workflows[].tags" type="string[]" required>
  Array of tags associated with the workflow.
</ResponseField>

<ResponseField name="workflows[].created_at" type="string" required>
  ISO 8601 timestamp when the workflow was created.
</ResponseField>

<ResponseField name="workflows[].updated_at" type="string" required>
  ISO 8601 timestamp when the workflow was last updated.
</ResponseField>

<ResponseField name="workflows[].started_at" type="string">
  ISO 8601 timestamp when execution started (null if not yet started).
</ResponseField>

<ResponseField name="workflows[].completed_at" type="string">
  ISO 8601 timestamp when execution completed (null if not yet completed).
</ResponseField>

## Example Response

```json theme={null}
{
  "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

<ResponseField name="401" type="error">
  Unauthorized - invalid or missing authentication token.
</ResponseField>

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