Skip to main content
GET
/
batches
/
{batch_id}
Retrieve a batch
curl --request GET \
  --url https://app.gomangrove.com/api/v1/batches/{batch_id} \
  --header 'Authorization: <api-key>'
{
  "id": "bat_abc123def456",
  "tracking_id": "Q1-2025-001",
  "start_time": "2025-01-01T00:00:00.000Z",
  "end_time": "2025-03-31T23:59:59.000Z",
  "state": "complete",
  "created_at": "2025-01-15T10:00:00.000Z",
  "updated_at": "2025-01-15T10:00:00.000Z",
  "primary_output": {
    "id": 1,
    "name": "Net Carbon Removal",
    "unit": "t",
    "data_point_type_id": 5,
    "value": 100.5
  },
  "ledger_balance": 50.25,
  "allocations": [],
  "model_run": {
    "id": 1,
    "start_time": "2025-01-01T00:00:00.000Z",
    "end_time": "2025-03-31T23:59:59.000Z",
    "state": "complete",
    "error_message": null,
    "created_at": "2025-01-15T10:00:00.000Z",
    "updated_at": "2025-01-15T10:00:00.000Z",
    "calculations": [],
    "output_data_points": []
  },
  "feedstocks": [],
  "input_data": [
    {
      "data_point": {
        "id": "in_abc123",
        "slug": "feedstock-mass",
        "data_point_type": "Mass of Feedstock",
        "value": 50.5,
        "unit": "t",
        "status": "complete"
      },
      "event": {
        "id": "evt_xyz789",
        "slug": "feedstock-delivery",
        "event_type": "Feedstock Delivery",
        "tracking_id": "FD-001",
        "start_time": "2025-01-15T00:00:00.000Z",
        "end_time": "2025-01-15T23:59:59.000Z"
      }
    }
  ],
  "report_allocations": [
    {
      "allocation": {
        "id": 1,
        "amount": 50.25,
        "unit": "t"
      },
      "amount": 50.25,
      "unit": "t",
      "report": {
        "id": "rpt_abc123",
        "name": "Q1 2025 Report",
        "report_type": "quarterly",
        "status": "complete"
      }
    }
  ],
  "downstream_batch_allocations": []
}

Authorizations

Authorization
string
header
required

Path Parameters

batch_id
string
required

Batch friendly ID (e.g., bat_abc123def456)

Response

200

id
string
Example:

"bat_abc123def456"

tracking_id
string
start_time
string<date-time>
end_time
string<date-time>
state
string
created_at
string<date-time>
updated_at
string<date-time>
primary_output
object
ledger_balance
number | null
allocations
object[]
model_run
object
feedstocks
object[]
input_data
object[]
report_allocations
object[]
downstream_batch_allocations
object[]