---
title: "List workflows"
method: GET
path: "/workflow"
tags: ["workflows"]
---

# List workflows

`GET /workflow`

Lists all workflow records, enriched with `attributes`. Append `?workspaceId` to list workflow records in a workspace context.

## Query parameters

- `attributes` WorkflowQueryAttribute[]
- `workspaceId` integer
- `max` integer
- `offset` integer
- `search` string
- `includeTotalSize` boolean

## Response `200`

OK

- ListWorkflowsResponse
  - `hasMore` boolean
  - `totalSize` integer
  - `workflows` ListWorkflowsResponseListWorkflowsElement[]
    - `labels` LabelDbDto[]
      - `dateCreated` string, date-time
      - `id` integer
      - `isDefault` boolean
      - `isDynamic` boolean
      - `isInterpolated` boolean
      - `name` string
      - `resource` boolean
      - `value` string
    - `optimized` boolean
    - `orgId` integer
    - `orgName` string
    - `pipelineInfo` PipelineMinInfoResponse
      - `id` integer
      - `version` PipelineMinInfoResponsePipelineVersionMinInfoResponse
        - `dateCreated` string, date-time
        - `hash` string
        - `id` string
        - `isDefault` boolean
        - `isDraftVersion` boolean
        - `lastUpdated` string, date-time
        - `name` string
      - `workspaceId` integer
    - `progress` ProgressData
      - `processesProgress` ProcessLoad[]
        - `aborted` integer, required
        - `cached` integer, required
        - `cpuEfficiency` number, float
        - `cpuLoad` integer, required
        - `cpus` integer, required
        - `cpuShareMillis` integer, nullable
        - `cpuShares` integer, nullable
        - `cpuTime` integer, required
        - `dateCreated` string, date-time
        - `failed` integer, required
        - `ignored` integer, required
        - `invCtxSwitch` integer, required
        - `lastUpdated` string, date-time
        - `loadCpus` integer, required
        - `loadMemory` integer, required
        - `loadTasks` integer, required
        - `memoryEfficiency` number, float
        - `memoryReq` integer, required
        - `memoryRss` integer, required
        - `peakCpus` integer, required
        - `peakMemory` integer, required
        - `peakTasks` integer, required
        - `pending` integer, required
        - `process` string, required
        - `readBytes` integer, required
        - `retries` integer, required
        - `running` integer, required
        - `submitted` integer, required
        - `succeeded` integer, required
        - `version` integer
        - `volCtxSwitch` integer, required
        - `writeBytes` integer, required
      - `totalProcesses` integer
      - `workflowProgress` WorkflowLoad
        - `aborted` integer, required
        - `cached` integer, required
        - `cost` number
        - `cpuEfficiency` number, float
        - `cpuLoad` integer, required
        - `cpus` integer, required
        - `cpuShareMillis` integer, nullable
        - `cpuShares` integer, nullable
        - `cpuTime` integer, required
        - `dateCreated` string, date-time
        - `executors` string[]
        - `failed` integer, required
        - `ignored` integer, required
        - `invCtxSwitch` integer, required
        - `lastUpdated` string, date-time
        - `loadCpus` integer, required
        - `loadMemory` integer, required
        - `loadTasks` integer, required
        - `memoryEfficiency` number, float
        - `memoryReq` integer, required
        - `memoryRss` integer, required
        - `netCost` number
        - `netCpuLoad` integer
        - `netCpus` integer
        - `netCpuShareMillis` integer, nullable
        - `netCpuShares` integer, nullable
        - `netCpuTime` integer
        - `netInvCtxSwitch` integer
        - `netMemoryConsumption` number
        - `netMemoryReq` integer
        - `netMemoryRss` integer
        - `netReadBytes` integer
        - `netVolCtxSwitch` integer
        - `netWriteBytes` integer
        - `numSpotInterruptions` integer
        - `peakCpus` integer, required
        - `peakMemory` integer, required
        - `peakTasks` integer, required
        - `pending` integer, required
        - `readBytes` integer, required
        - `requestedCpuTime` integer, nullable
        - `requestedMemory` integer, nullable
        - `retries` integer, required
        - `running` integer, required
        - `submitted` integer, required
        - `succeeded` integer, required
        - `version` integer
        - `volCtxSwitch` integer, required
        - `writeBytes` integer, required
    - `starred` boolean
    - `workflow` WorkflowDbDto
      - `commandLine` string
      - `commitId` string
      - `complete` string, date-time
      - `configFiles` string[]
      - `configText` string
      - `container` string
      - `containerEngine` string
      - `dateCreated` string, date-time
      - `deleted` boolean
      - `duration` integer
      - `errorMessage` string
      - `errorReport` string
      - `exitStatus` integer
      - `homeDir` string
      - `id` string
      - `lastUpdated` string, date-time
      - `launchDir` string
      - `launchId` string
      - `manifest` WfManifest
        - `author` string
        - `defaultBranch` string
        - `description` string
        - `gitmodules` string
        - `homePage` string
        - `icon` string
        - `mainScript` string
        - `name` string
        - `nextflowVersion` string
        - `version` string
      - `nextflow` WfNextflow
        - `build` string
        - `timestamp` string, date-time
        - `version` string
      - `ownerId` integer
      - `params` object
      - `profile` string
      - `projectDir` string
      - `projectName` string
      - `repository` string
      - `requiresAttention` boolean
      - `resume` boolean
      - `revision` string
      - `runName` string
      - `scriptFile` string
      - `scriptId` string
      - `scriptName` string
      - `sessionId` string
      - `start` string, date-time
      - `stats` WfStats
        - `cachedCount` integer
        - `cachedCountFmt` string
        - `cachedDuration` integer
        - `cachedPct` number, float
        - `computeTimeFmt` string
        - `failedCount` integer
        - `failedCountFmt` string
        - `failedDuration` integer
        - `failedPct` number, float
        - `ignoredCount` integer
        - `ignoredCountFmt` string
        - `ignoredPct` number, float
        - `succeedCount` integer
        - `succeedCountFmt` string
        - `succeedDuration` integer
        - `succeedPct` number, float
      - `status` 'SUBMITTED' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'CANCELLED' | 'UNKNOWN'
      - `submit` string, date-time
      - `success` boolean
      - `userName` string
      - `workDir` string
    - `workspaceId` integer
    - `workspaceName` string

## Other responses

- `400` — Bad request
- `403` — Operation not allowed

---

[API](https://skmtc.net/seqeralabs/apis/seqera-api.md) · [All operations](https://skmtc.net/seqeralabs/apis/seqera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/seqeralabs/seqera-api/revisions/13316c9fe5ff/schema)