---
title: "List batches"
method: GET
path: "/api/v1/batches"
tags: ["Batches"]
---

# List batches

`GET /api/v1/batches`

## Query parameters

- `page` integer
- `perPage` integer
- `type` 'walletMessaging' | 'passCreation' | 'passUpdate'

## Response `200`

Successful

- object
  - `data` 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
  - `links` IndexLinks
    - `first` string, nullable — Path to first page, null if currentPage is first page
    - `prev` string, nullable — Path to prev page, null if currentPage is first page
    - `next` string, nullable — Path to next page, null if currentPage is last page
    - `last` string, nullable — Path to last page, null if currentPage is last page
  - `meta` IndexMeta
    - `totalCount` integer — Total count of records returned
    - `resultsPerPage` integer — Number of records returned per page. Set using the perPage query parameter.
    - `currentPage` integer — Index of current page
    - `totalPages` integer — Total pages returned

## Other responses

- `401` — Error: Unauthorized

---

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