Skip to main content
GET
/
batches
List all batches
curl --request GET \
  --url https://app.gomangrove.com/api/v1/batches \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "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": []
    }
  ],
  "info": {
    "items": 1,
    "page_size": 10,
    "total_items": 1,
    "current_page": 1,
    "next_page": null,
    "previous_page": null,
    "total_pages": 1,
    "sort": [],
    "filter": []
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.mangrovesystems.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Query Parameters

​
filter[project_id][eq]
integer

Filter by project ID

​
page
integer<int32>
default:1
​
page_size
integer<int32>
default:10
​
sort
string

Comma-separated list of fields to sort by. Prefix with - for descending. Available fields: id, start_time, end_time, state, created_at, updated_at

Example:

"-created_at"

​
filter[id][eq]
string

Filter by exact batch ID

​
filter[state][eq]
string

Filter by batch state

Response

200

​
data
object[]
​
info
object