---
title: "List dead letters"
method: GET
path: "/v2/pipelines/{pipeline_key}/dead_letters"
tags: ["Pipeline Dead Letters"]
---

# List dead letters

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

Lists dead letters for a pipeline, with optional filtering by status or run.

## 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` 'pending' | 'retrying' — The status of a dead letter entry.
- `last_run_id` string — The unique identifier for a pipeline run.
- `origin` 'pipeline' | 'manual' — How this dead letter was created.
- `filter` string
- `limit` integer
- `page_key` string

## Headers

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

## Response `200`

List of dead letters.

- ListPipelineDeadLetterEntriesResponse — Response containing a list of pipeline dead letters.
  - `dead_letters` PipelineDeadLetterEntry[], required
    - `id` string, required — The unique identifier for this dead letter entry.
    - `source_record_id` string, required — The identifier for the source record. Format depends on connector type: - S3: the object key (e.g. `legal/contracts/doc.pdf`) - SharePoint: the drive item ID - Google Drive: the file ID - Box: the file ID (e.g. `1422162456741`) - Wolken: the article number (e.g. `345678`) - Confluence: the page ID (e.g. `123456789`) - Web: the canonicalized URL (e.g. `https://docs.example.com/page`)
    - `status` 'pending' | 'retrying', required — The status of a dead letter entry.
    - `error_message` string, nullable — The error message from the most recent failed processing attempt.
    - `last_run_id` string — The unique identifier for a pipeline run.
    - `attempt_count` integer, required — The number of times this record has been attempted.
    - `origin` 'pipeline' | 'manual', required — How this dead letter was created.
    - `created_at` string, date-time, required — When this dead letter was first recorded.
    - `updated_at` string, date-time, nullable — When this dead letter was last updated.
  - `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 dead letters 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/83554494d7f8/schema)