v1

latestOpenAPI 3.0.32026-07-1765123145.7 KB

ledger.v2

List ledgers

get/v2

Query parameters

pageSizeinteger

The maximum number of results to return per page.

cursorstring

Example:aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==

Parameter used in pagination requests. Maximum page size is set to 15. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.

includeDeletedboolean

If true, include deleted ledgers in the results. By default, deleted ledgers are excluded.

sortstring

Example:id:desc

Sort results using a field name and order (ascending or descending). Format: <field>:<order>, where <field> is the field name and <order> is either asc or desc.

Request body

object required

Response

Example response

{
  "cursor": {
    "pageSize": 15,
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "next": "aW0gdmVuaWFtLCBxdWlzIG5vc3RydWQ=",
    "data": [
      {
        "metadata": {
          "admin": "true"
        }
      }
    ]
  }
}