---
title: "Retrieve a batch"
method: GET
path: "/batches/{id}"
tags: ["Batches"]
---

# Retrieve a batch

`GET /batches/{id}`

Retrieve a specific batch based on its ID. This is useful to check whether a batch has finished
processing and to get the results. Some requests in the batch may have succeeded while others failed.
The `result` field provides the details.

## Path parameters

- `id` integer, required

## Query parameters

- `showErrorDetails` boolean

## Response `200`

The batch details

- Batch
  - `id` integer
  - `batchType` string
  - `batchJson` object
  - `createdOn` string
  - `status` string — NEW, PROCESSING, or COMPLETED
  - `result` object, nullable
    - `errors` object[]
      - `id` union
        - string
        - integer
      - `description` string
    - `successes` string[]

## Other responses

- `401` — Unauthorized
- `404` — Batch not found

---

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