WorkflowList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/circleci/main/json-schema/circleci-workflow-list-schema.json",
  "title": "WorkflowList",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/circleci-pipeline-api-openapi.yml#/components/schemas/WorkflowList",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Workflow"
      },
      "description": "List of workflows"
    },
    "next_page_token": {
      "type": "string",
      "description": "Token for retrieving the next page"
    }
  },
  "$defs": {
    "Workflow": {
      "type": "object",
      "properties": {
        "pipeline_id": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the pipeline this workflow belongs to"
        },
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The unique identifier of the workflow"
        },
        "name": {
          "type": "string",
          "description": "The name of the workflow"
        },
        "project_slug": {
          "type": "string",
          "description": "The project slug"
        },
        "status": {
          "type": "string",
          "enum": [
            "success",
            "running",
            "not_run",
            "failed",
            "error",
            "failing",
            "on_hold",
            "canceled",
            "unauthorized"
          ],
          "description": "The current status of the workflow"
        },
        "started_by": {
          "type": "string",
          "format": "uuid",
          "description": "The ID of the user who started the workflow"
        },
        "pipeline_number": {
          "type": "integer",
          "description": "The pipeline number"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "When the workflow was created"
        },
        "stopped_at": {
          "type": "string",
          "format": "date-time",
          "description": "When the workflow stopped"
        }
      }
    }
  }
}