---
title: "Read batch and row outcomes"
method: GET
path: "/batches/{id}"
tags: ["Batches and files"]
---

# Read batch and row outcomes

`GET /batches/{id}`

## Request

- Base URL: `https://www.sanctionskit.com/api/v1`
- URL: `https://www.sanctionskit.com/api/v1/batches/{id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sanctionskit/apis/sanctionskit-api/docs/batches/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Required API key scope: results:read.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Successful response. JSON object with the required data key. All properties marked required are present, including keys whose value may be null. Unmarked properties can be omitted; clients should tolerate additional response properties.

- object
  - `data` BatchDetail, required
    - `id` string, uuid, required
    - `name` string, required
    - `environment` 'sandbox' | 'production', required
    - `status` 'importing' | 'pending' | 'processing' | 'completed' | 'cancelled' | 'failed', required
    - `total` integer, required
    - `completed` integer, required
    - `failed` integer, required
    - `created_at` string, date-time, required
    - `cancelled_at` string, date-time, nullable, required
    - `rows` object[], required: Current row outcomes for this page, ordered by one-based row_number. A failed row contains error; retrieve completed evidence using screening_id.
      - `row_number` integer, required
      - `status` 'pending' | 'completed' | 'failed' | 'cancelled', required
      - `screening_id` string, uuid, nullable, required
      - `error` object, nullable, required
        - `code` string, required
        - `message` string, required
    - `nextOffset` integer, nullable, required: Pass this integer as the next offset. Null means all currently counted rows were returned; an importing batch may not have its final total yet.

## Other responses

- `400`: **invalid_request** — Correct the request fields, resource identifiers, JSON body or query parameters before retrying.
- `401`: **authentication_required** — Send Authorization: Bearer with a valid API key. An omitted header can produce authentication_required; invalid supplied credentials produce invalid_api_key. **invalid_api_key** — Use an active key for the intended environment.
- `403`: **permission_denied** — Ask an organization owner to grant the required role or API-key scope. **insufficient_scope** — Use a key with the scope stated in this operation.
- `404`: **not_found** — Check the identifier and selected environment. The resource must belong to your organization and remain available.
- `405`: **method_not_allowed** — Use a method in the Allow response header. OPTIONS lists supported methods; HEAD follows GET authorization and returns no body.
- `413`: **response_too_large** — Reduce the requested page size or use the documented segmented case archive. No evidence is silently truncated.
- `429`: **rate_limited** — Wait for the request window to reset and retry with backoff.
- `500`: **internal_error** — Retry with backoff. For writes reuse the same idempotency key and identical input; include requestId when contacting support.
- `503`: **temporarily_unavailable** — Honor Retry-After when present and retry with bounded backoff. Follow this endpoint’s retry contract; preserve the same key and input for idempotent writes. Contact support with requestId if the failure persists.

---

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