List batches

GET /api/v1/batches

executions:read

Batches created by the calling api_client, newest first. Requires executions:read.

Query parameters

Name	Type	Description
`page`	integer	1-based page number. Example: `1`
`per_page`	integer	Items per page. Values above 100 are clamped to 100. Example: `25`
`filter[status]`	string	CSV of `pending, running, interrupted, completed, cancelled`
`filter[workflow_id]`	integer
`filter[external_reference]`	string

Responses

200 Batch list application/json
- data array of Batch
  
  id integer
  
  object string
  
  workflow_id integer
  
  status string `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 One of test live
  
  external_reference string, nullable
  
  total_count integer
  
  completed_count integer
  
  failed_count integer
  
  started_at string (date-time), nullable
  
  completed_at string (date-time), nullable
  
  created_at string (date-time)
  
  updated_at string (date-time)
- meta Meta
  
  Schema: PaginatedMeta
  
  request_id string required Correlation id for this request. Also sent as the `X-Request-Id` response header; quote it when contacting support.
  
  page integer required
  
  per_page integer required
  
  total_count integer required
  
  total_pages integer required
  
  object string required The object type of every item in `data`.
200 example
```
{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "object": "execution"
  }
}
```

401 Missing, malformed, expired or revoked bearer token. The WWW-Authenticate header carries the RFC 6750 challenge. application/json

Schema: ErrorEnvelope

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "A valid bearer token is required.",
    "details": [],
    "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
    "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/unauthorized"
  }
}

403 Token does not hold the required scope. details lists the scope(s) that were checked. application/json

Schema: ErrorEnvelope

403 example

{
  "error": {
    "code": "insufficient_scope",
    "message": "This token does not have the required scope.",
    "details": [
      {
        "field": "scope",
        "message": "executions:write"
      }
    ],
    "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
    "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/insufficient_scope"
  }
}

422 Request body or params failed validation application/json

Schema: ErrorEnvelope

422 example

{
  "error": {
    "code": "validation_failed",
    "message": "The request could not be processed.",
    "details": [
      {
        "field": "execution_mode",
        "message": "must be test or live"
      }
    ],
    "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
    "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/validation_failed"
  }
}

429 Rate limit exceeded (60 req/min per IP on /api/v1, 600 req/hour per token prefix, or 300 req/5 min per IP globally). The body is the standard error envelope and Retry-After gives the seconds until the window resets. application/json

Schema: ErrorEnvelope

429 example

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry later.",
    "details": [],
    "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
    "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/rate_limited"
  }
}

Markdown version · OpenAPI

Query parameters

Responses

Related