---
title: "List batches"
method: GET
path: "/api/v1/automations/{automationId}/batches"
tags: ["automations"]
---

# List batches

`GET /api/v1/automations/{automationId}/batches`

## Request

- Base URL: `https://api.capy.ai`
- URL: `https://api.capy.ai/api/v1/automations/{automationId}/batches`
- Auth: HTTP bearer

## Path parameters

- `automationId` string, required

## Query parameters

- `limit` string
- `cursor` string
- `status` 'collecting' | 'queued' | 'cancelled': Collecting accepts events; queued has one automation run; cancelled retains scrubbed history without a run.

## Response `200`

AutomationWebhookBatchPage

- AutomationWebhookBatchPageEncoded
  - `items` AutomationWebhookBatchEncoded[], required
    - `id` string, required
    - `automationId` string, required
    - `triggerId` string, required
    - `status` 'collecting' | 'queued' | 'cancelled', required: Collecting accepts events; queued has one automation run; cancelled retains scrubbed history without a run.
    - `group` WebhookBatchGroupValue[], required
      - union: A non-null finite JSON scalar; string, number, and boolean grouping values remain distinct.
        - string
        - number
        - boolean
    - `eventCount` integer, required
    - `byteCount` integer, required
    - `firstEventAt` string, required
    - `lastEventAt` string, required
    - `dispatchAfter` string, required
    - `maxEvents` integer, required
    - `maxWaitSeconds` integer, required
    - `quietPeriodSeconds` integer, nullable, required
    - `closedAt` string, nullable, required
    - `reason` 'count' | 'quiet' | 'max_wait' | 'bytes' | 'manual' | 'cancelled' | 'configuration_changed' | 'disabled' | 'project_deleted', required: The boundary that closed or cancelled a webhook batch.
    - `runId` string, nullable, required
    - `runStatus` 'queued' | 'running' | 'completed' | 'failed' | 'skipped' | 'cancelled', nullable, required
    - `jamId` string, nullable, required
    - `failure` string, nullable, required
  - `cursor` string, required

## Other responses

- `401`: capy/Unauthorized
- `403`: capy/Forbidden
- `404`: capy/AutomationNotFound
- `429`: capy/RateLimited

## Changes

- **2026-09-30** `7187d2287ecd`: 1 info
  - added the non-success response with the status `403`
- **2026-09-24** `0de0f8cfab7d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/capy/apis/capy-api/changes/api/v1/automations/:automationId/batches/get.md)

---

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