← Back to API index
GET /batch/list

List recent batches

Options

Options are grouped for easier scanning, similar to parameter-focused docs.

App

key

query string Optional

API key (optional if using JWT bearer token)

API key used for authentication. Use either the `key` query parameter or `X-API-KEY` header.

limit

query integer Optional

Example: 25

Maximum number of batches to return

Responses

200

Batch list

▾ 
{
  "success": true,
  "data": [
    {
      "id": 98765,
      "status": "finished",
      "count": 150,
      "processed": 148,
      "failed": 2,
      "error": ""
    }
  ]
}
401

Unauthorized

▾ 
{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}
403

Forbidden

▾ 
{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}
500

Server error

▾ 
{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}