---
title: "List Payload Metadata"
method: GET
path: "/api/v1/payload-metadata"
tags: ["Payload Metadata"]
---

# List Payload Metadata

`GET /api/v1/payload-metadata`

Retrieves a paginated list of payload metadata records. Can be filtered by `id`, `flow_run_id`, `flow_step_id`, and `flow_log_id`.

## Query parameters

- `filter[id]` string
- `filter[flow_run_id]` string
- `filter[flow_step_id]` string
- `filter[flow_log_id]` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

Successful response

- PayloadMetadataListResponse
  - `data` PayloadMetadata[]
    - `id` integer — Unique identifier
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `flow_version_id` integer
    - `flow_step_id` integer
    - `flow_run_id` integer
    - `payload_store_reference` string
    - `payload_size` string
    - `dropped` 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)