---
title: "List all Batches"
method: GET
path: "/2024-09/batches"
tags: ["Batches"]
---

# List all Batches

`GET /2024-09/batches`

Retrieve a list of all batches ordered by date of creation.

Required authorization scope: `public.batch:read`

## Query parameters

- `page` integer
- `per_page` integer
- `state` 'created' | 'processing' | 'processed' | 'failed'
- `type` 'shipment_batch' | 'address_batch' | 'label_batch'

## Response `200`

list of batches

- BatchList — List of Batches
  - `batches` Batch[]
    - `id` string, uuid — Batch ID
    - `state` 'created' | 'processing' | 'processed' | 'failed' — Batch state
    - `type` 'shipment_batch' | 'address_batch' | 'label_batch' — Batch type
    - `started_at` string, datetime, nullable
    - `finished_at` string, datetime, nullable
    - `created_at` string, datetime
    - `updated_at` string, datetime
  - `meta` MetaWithPagination
    - `pagination` Pagination — Pagination
      - `next` integer, nullable
      - `count` integer, nullable — The total number of items. The `null` value is used with countless pagination (used for faster response on large datasets, like shipments).
      - `page` integer — Current page
    - `request_id` string — An unique ID represent the request.

---

[API](https://skmtc.net/easyship/apis/easyship-public-api.md) · [All operations](https://skmtc.net/easyship/apis/easyship-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/easyship/easyship-public-api/versions/71d737a5fcbf/schema)