---
title: "Returns one batch's status, progress, and aggregated results."
method: GET
path: "/api/batches/{uuid}"
tags: ["batches"]
---

# Returns one batch's status, progress, and aggregated results.

`GET /api/batches/{uuid}`

## 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/{uuid}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Path parameters

- `uuid` string, required

## Response `200`

The requested batch.

- BatchResponse: A batch with its status, progress, aggregated results, and recommendation counts.
  - `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

## Other responses

- `400`: Malformed uuid.
- `401`: Missing or invalid API key, session token, or agent token.
- `403`: The key or agent token lacks the `results:read` scope.
- `404`: No batch with that uuid belongs to the caller.

---

[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)