v1

latestOpenAPI 3.0.02026-07-24231140.6 KB
BRGC Batches

Get a specific BRGC batch by ID

Retrieves detailed information about a specific batch. You can only access batches you created.

Rate Limit: 60 requests per 10 minutes

get/brgc-batches/{batchId}

Path parameters

batchIdstring required

The batch identifier (with or without 'batch-' prefix)

Response

Success

metaobject

Example response

{
  "data": {
    "batch_id": "batch-marketing-2025-abc123def456",
    "total_quantity": 100,
    "total_amount": 500,
    "total_redeemed": 42,
    "redemption_rate": 42,
    "currency": "EUR",
    "created_time": "2024-01-01T12:00:00.000Z",
    "expiration_date": "2025-01-01T23:59:59.999Z",
    "details": [
      {
        "count": 10,
        "value": 5
      }
    ]
  }
}