Get Batch Status API

Overview

The Get Batch Status API allows you to check the processing status of asynchronous batch operations such as creating or updating multiple passes. This endpoint provides real-time information about the progress, success/failure details, and results of batch operations. Use this endpoint to monitor long-running operations and handle any errors that occurred during processing.

Path Parameters

• batchId (string): The unique identifier of the batch operation to check

Authentication

All API requests must include your API key in the request headers:

"apikey": "your-api-key-here"

Request Example

GET /api/v2/batch/status/batch_66b6005bb7bddce8f05a3400
apikey: your-api-key-here

Response

The API returns detailed information about the batch operation status:

Response Example

{
  "processed": 1,
  "total": 2,
  "success": 1,
  "failed": 0,
  "createdAt": "2025-09-08T17:55:35.455Z",
  "dynamicPassId": "68bf18981f2430ea0622e14a",
  "lastUpdatedAt": "2025-09-08T17:55:46.115Z",
  "message": "Created 1 of 2 passes...",
  "progress": 0.5,
  "successful": [
    {
      "_customerId": "68bf18981f2430ea0622e14e",
      "name": "AddTowallet.co",
      "email": "[email protected]",
      "org": "test",
      "passId": "68bf18a0fd78024404330b8b"
    }
  ],
  "processing": [
    {
      "_customerId": "68bf18981f2430ea0622e14f",
      "name": "John Doe",
      "email": "[email protected]"
      org: "test"
    }
  ]
}

Polling for Updates

For batch operations that are still processing, you should poll this endpoint periodically to check for updates. Recommended polling intervals:

• Every 2-5 seconds for small batches (<50 items)
• Every 5-10 seconds for medium batches (50-200 items)
• Every 10-30 seconds for large batches (>200 items)