Skip to main content
GET
/
api
/
ledger
/
v2
List ledgers
curl --request GET \
  --url http://localhost/api/ledger/v2 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "cursor": {
    "pageSize": 15,
    "hasMore": false,
    "data": [
      {
        "name": "<string>",
        "addedAt": "2023-11-07T05:31:56Z",
        "bucket": "<string>",
        "metadata": {
          "admin": "true"
        },
        "features": {},
        "id": 123
      }
    ],
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "next": ""
  }
}

Documentation Index

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

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

Retrieve all ledgers in the system. Each ledger is an isolated double-entry accounting system.

​
Parameters

pageSize: Number of ledgers to return per page. Defaults to 15, maximum 1000. (e.g., 100) cursor: Pagination cursor from a previous response. (e.g., aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==) includeDeleted: When true, includes soft-deleted ledgers in the results.

​
Request Body

Filter criteria. Use $match to filter by ledger name or metadata. See Filtering Queries for full syntax. Example: 
{
  "$match": {
    "metadata[environment]": "production"
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
pageSize
integer<int64>

The maximum number of results to return per page.

Required range: 1 <= x <= 1000
​
cursor
string

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.

Example:

"aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="

​
sort
string

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.

Example:

"id:desc"

Body

application/json

The body is of type object.

Response

OK

​
cursor
object
required