---
title: Batch schema
description: Fields of the Batch object in the Cascades API.
canonical_url: "https://cascades.crscreditapi.com/docs/api/schemas/Batch"
doc_version: "1.0.0"
last_updated: "2026-10-09T18:04:24Z"
source: "public/api-docs/v1/swagger.yaml#/components/schemas/Batch"
---

# Batch

Defined in [openapi.json](https://cascades.crscreditapi.com/openapi.json#/components/schemas/Batch) ([YAML](https://cascades.crscreditapi.com/openapi.yaml)).

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | integer | no |  |
| `object` | string | no |  |
| `workflow_id` | integer | no |  |
| `status` | string | no | `completed` means every row reached a terminal status, even when some rows failed (see `failed_count`). `failed` means the batch itself stopped on an unexpected error; it is not accepted by `filter[status]` on `listBatches`. One of: `"pending"`, `"running"`, `"interrupted"`, `"completed"`, `"cancelled"`, `"failed"`. |
| `execution_mode` | string | no |  One of: `"test"`, `"live"`. |
| `external_reference` | string, nullable | no |  |
| `total_count` | integer | no |  |
| `completed_count` | integer | no |  |
| `failed_count` | integer | no |  |
| `started_at` | string (date-time), nullable | no |  |
| `completed_at` | string (date-time), nullable | no |  |
| `created_at` | string (date-time) | no |  |
| `updated_at` | string (date-time) | no |  |

```json
{
  "id": 77,
  "object": "batch",
  "workflow_id": 1,
  "status": "pending",
  "execution_mode": "test",
  "external_reference": "rentvine-batch-001",
  "total_count": 1,
  "completed_count": 1,
  "failed_count": 1,
  "started_at": "2026-05-08T18:41:05Z",
  "completed_at": "2026-05-08T18:41:05Z",
  "created_at": "2026-05-08T18:41:05Z",
  "updated_at": "2026-05-08T18:41:05Z"
}
```

## Sitemap

See the full [sitemap](https://cascades.crscreditapi.com/sitemap.md) for all pages.