---
title: "List Flow Runs"
method: GET
path: "/api/v1/flow-runs"
tags: ["Flow Run Logs"]
---

# List Flow Runs

`GET /api/v1/flow-runs`

Retrieves a paginated list of flow runs. Can be filtered by `user_id`, `flow_id`, `flow_version_id`, `virtual_environment_id`, `trigger`, `status`, date range, and other criteria.

## Query parameters

- `filter[user_id]` string
- `filter[flow_id]` string
- `filter[flow_version_id]` string
- `filter[virtual_environment_id]` string
- `filter[trigger]` string
- `filter[status]` string
- `filter[search]` string
- `filter[started_before]` string
- `filter[started_after]` string
- `filter[started_on]` string
- `filter[retried]` string
- `filter[has_warnings]` string
- `include` string
- `sort` string
- `fields[trackedData]` string
- `fields[flow]` string
- `fields[flowVersion]` string
- `fields[retriedFlowRun]` string
- `page` integer
- `per_page` integer

## Response `200`

Successful response

- FlowRunsListResponse
  - `data` FlowRuns[]
    - `id` integer — Unique identifier
    - `name` string
    - `payload.id` string
    - `steps.name` string
    - `status` 'Draft' | 'Inactive' | 'Deployed'
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `flow_id` object
    - `flow_version_id` object
    - `virtual_environment_version` object
    - `user_id` integer
    - `trigger` 'API' | 'Manual' | 'Router' | 'Webhook' | 'Schedule' | 'Shape' | 'Retry' | 'Event' | 'Callback'
    - `summary` string
    - `started_at` string, date-time
    - `finished_at` string, date-time
    - `duration` object
    - `retry_flow_run_id` object
    - `retried_flow_run` object[]
    - `has_warnings` object[]
    - `flow_run_logs` object[]
    - `flow` object[]
    - `flow_version` object[]
    - `metrics` object[]
    - `cpu_time` string
    - `payload_size` string
    - `operations_sent` string
    - `operations_received` string
    - `score` string
    - `starting_payload_count` integer
    - `starting_payload_size` string
    - `flow_steps_with_errors` string
    - `user_email` string
  - `meta` PaginationMeta
    - `current_page` integer
    - `from` integer, nullable
    - `last_page` integer
    - `path` string
    - `per_page` integer
    - `to` integer, nullable
    - `total` integer
  - `links` PaginationLinks
    - `first` string, uri
    - `last` string, uri
    - `prev` string, uri, nullable
    - `next` string, uri, nullable

## Other responses

- `401` — Unauthenticated
- `403` — Unauthorized

---

[API](https://skmtc.net/wearepatchworks/apis/patchworks-core-api.md) · [All operations](https://skmtc.net/wearepatchworks/apis/patchworks-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wearepatchworks/patchworks-core-api/revisions/89261af4dd80/schema)