---
title: "Show batch"
method: GET
path: "/api/v1/batches/{id}"
tags: ["Batches"]
---

# Show batch

`GET /api/v1/batches/{id}`

## Response `200`

Successful

- object
  - `data` union
    - SerializedWalletMessagingBatch
      - `id` string — UUID of the batch
      - `type` 'walletMessaging' — Type of batch
      - `attributes` object
        - `name` string — Friendly name of the batch, used for display purposes. Auto-generated if not provided
        - `status` 'validating' | 'scheduled' | 'failed' | 'sending' | 'successful' | 'completedWithErrors' | 'cancelled' — Status of the batch
        - `tag` string, nullable — Tag of the batch, used for grouping and filtering purposes
        - `content` string — Message content
        - `totalRecipients` integer — Total number of recipients in the batch
        - `completedAt` string — ISO8601 timestamp of when the batch was completed
        - `scheduledAt` string — ISO8601 timestamp of when the batch is scheduled to be sent
        - `errorsCsvUrl` string — If present, batch failed validation, or had some errors during delivery. URL to a CSV file containing errors and error details of the batch
    - SerializedPassCreationBatch
      - `id` string — UUID of the batch
      - `type` 'passCreation' — Type of batch
      - `attributes` object
        - `name` string — Friendly name of the batch, used for display purposes. Auto-generated if not provided
        - `status` 'processing' | 'successful' | 'failed' — Status of the batch
        - `completedAt` string — ISO8601 timestamp of when the batch was completed
        - `passTemplateName` string — Name of the pass template
        - `passTemplateNameId` string — ID of the pass template
        - `resultCsvUrl` string — URL to a CSV file containing the results of the batch
        - `totalCount` integer — If present, total number of passes created in the batch
        - `progress` object — Shown when batch is processing. Progress of the batch, can be polled for real-time updates.
          - `total` integer — Total number of passes to be created in the batch
          - `processed` integer — Number of passes processed in the batch
          - `pending` integer — Number of passes pending to be created in the batch
    - SerializedPassUpdateBatch
      - `id` string — UUID of the batch
      - `type` 'passUpdate' — Type of batch
      - `attributes` object
        - `name` string — Friendly name of the batch, used for display purposes. Auto-generated if not provided
        - `status` 'validating' | 'scheduled' | 'failed' | 'updating' | 'successful' | 'completedWithErrors' | 'cancelled' — Status of the batch
        - `tag` string — Tag of the batch, used for grouping and filtering purposes
        - `passTemplateName` string — Name of the pass template
        - `passTemplateNameId` string — ID of the pass template
        - `completedAt` string — ISO8601 timestamp of when the batch was completed
        - `errorsCsvUrl` string — If present, batch failed validation, or had some errors during update. URL to a CSV file containing errors and error details of the batch
        - `totalCount` integer — If present, total number of passes to be updated in the batch
        - `progress` object — Shown when batch is validating or updating. Progress of the batch, can be polled for real-time updates.
          - `total` integer — Total number of passes to be created in the batch
          - `processed` integer — Number of passes processed in the batch
          - `pending` integer — Number of passes pending to be created in the batch

## Other responses

- `401` — Error: Unauthorized

---

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