Skip to main content
GET
/
ledgers
List all ledgers
curl --request GET \
  --url https://app.gomangrove.com/api/v1/ledgers \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "lgr_abc123def456",
      "name": "Net Carbon Removal",
      "unit": "t",
      "system_ledger_type": null,
      "created_at": "2025-01-15T10:00:00.000Z",
      "updated_at": "2025-01-15T10:00:00.000Z"
    }
  ],
  "info": {
    "items": 1,
    "page_size": 10,
    "total_items": 1,
    "current_page": 1,
    "next_page": null,
    "previous_page": null,
    "total_pages": 1,
    "sort": [],
    "filter": []
  }
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
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, name, created_at, updated_at

Example:

"name,-created_at"

​
filter[id][eq]
string

Filter by exact ledger ID (friendly_id)

​
filter[name][contains]
string

Filter by name (case-insensitive partial match)

​
filter[unit][eq]
string

Filter by unit

​
filter[system_ledger_type][eq]
string

Filter by system ledger type

​
filter[created_at][geq]
string<date-time>
​
filter[created_at][leq]
string<date-time>
​
filter[updated_at][geq]
string<date-time>
​
filter[updated_at][leq]
string<date-time>

Response

200

​
data
object[]
​
info
object