---
title: "List pipeline runs"
method: GET
path: "/v2/pipelines/{pipeline_key}/runs"
tags: ["Pipeline Runs"]
---

# List pipeline runs

`GET /v2/pipelines/{pipeline_key}/runs`

Lists execution runs for a pipeline, with optional filtering by status.

## Path parameters

- `pipeline_key` string, required — The unique key for the pipeline. You can provide the key, or the platform generates one.

## Query parameters

- `status` 'running' | 'completed' | 'failed' | 'cancelled' — The status of a pipeline run.
- `after` string, date-time
- `limit` integer
- `page_key` string

## Headers

- `Request-Timeout` integer
- `Request-Timeout-Millis` integer

## Response `200`

List of pipeline runs.

- ListPipelineRunsResponse — Response containing a list of pipeline runs.
  - `runs` PipelineRun[], required
    - `id` string, required — The unique identifier for a pipeline run.
    - `pipeline_key` string, required — The unique key for the pipeline. You can provide the key, or the platform generates one.
    - `agent_key` string, required — A unique key that identifies an agent.
    - `status` 'running' | 'completed' | 'failed' | 'cancelled', required — The status of a pipeline run.
    - `trigger_type` 'scheduled' | 'manual' | 'retry', required — What initiated the pipeline run.
    - `records_fetched` integer, required — Number of records discovered from the source in this run.
    - `records_processed` integer, required — Number of records successfully processed by the agent.
    - `records_failed` integer, required — Number of records that failed processing.
    - `error` string, nullable — Error details if the run failed.
    - `started_at` string, date-time, nullable — When the run started executing.
    - `completed_at` string, date-time, nullable — When the run finished.
    - `created_at` string, date-time, required — When the run was created.
  - `metadata` ListMetadata, required — The standard metadata in the response of a list operation.
    - `page_key` string — The page key for the next page of results. Pass it as a query parameter to request the next page.

## Other responses

- `403` — Permissions do not allow listing runs for this pipeline.
- `404` — Pipeline not found.

---

[API](https://skmtc.net/vectara/apis/vectara-rest-api-v2.md) · [All operations](https://skmtc.net/vectara/apis/vectara-rest-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vectara/vectara-rest-api-v2/revisions/e85040b266cc/schema)