---
title: "Lists the caller's bulk-verification batches, newest first, paginated."
method: GET
path: "/api/batches"
tags: ["batches"]
---

# Lists the caller's bulk-verification batches, newest first, paginated.

`GET /api/batches`

## Request

- Base URL: `https://api.pricklymails.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.pricklymails.com/api/batches`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Paginated batch list, newest first.

- ListBatchesResponse: `GET /api/batches` response body.
  - `batches` BatchResponse[], required: The caller's batches, newest first.
    - `created_at` string, required
    - `error` string, nullable
    - `name` string, nullable
    - `progress` BatchProgressDto, required: Progress counters of a batch.
      - `failed` integer, required
      - `percent_complete` integer, required
      - `processed` integer, required
      - `skipped` integer, required
      - `succeeded` integer, required
      - `total` integer, required
    - `recommendations` RecommendationCountsDto, required: Recommendation-bucket counts (`remove`, `review`, `send`) for a batch's completed jobs.
      - `remove` integer, required
      - `review` integer, required
      - `send` integer, required
    - `results` BatchResultsDto, required: Aggregated verdict counts of a batch.
      - `duplicates` integer, required
      - `invalid` integer, required
      - `risky` integer, required
      - `syntax_errors` integer, required
      - `unknown` integer, required
      - `valid` integer, required
    - `status` string, required
    - `updated_at` string, required
    - `uuid` string, required
  - `limit` integer, required: Pagination limit used for this page (effective after clamping).
  - `offset` integer, required: Pagination offset used for this page.

## Other responses

- `401`: Missing or invalid API key, session token, or agent token.
- `403`: The key or agent token lacks the `results:read` scope.

---

[API](https://skmtc.dev/pricklymails/apis/pricklymails-api.md) · [All operations](https://skmtc.dev/pricklymails/apis/pricklymails-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pricklymails/apis/pricklymails-api/revisions/b4225a92d8fb?raw)