v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

List Ledgers

get/ledgers

Query parameters

id[]string[]

If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with id[]=, for example ?id[]=123&id[]=abc.

metadatastring

For example, if you want to query for ledgers with metadata key Type and value Loan, the query would be metadata%5BType%5D=Loan. This encodes the query parameters.

updated_atstring date-time

Use "gt" (>), "gte" (>=), "'lt" (<), "lte" (<=), or "eq" (=) to filter by the posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use updated_at%5Bgt%5D=2000-01-01T12:00:00Z.

after_cursorstring

per_pageinteger

Response

200

idstring

objectstring

live_modeboolean

namestring

{"stackTrail":"paths:/ledgers:get:responses:200:content:application/json:schema:items:properties:description","oasType":"schema","type":"unknown"}

metadataobject

{"stackTrail":"paths:/ledgers:get:responses:200:content:application/json:schema:items:properties:discarded_at","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

Example response

[
  {
    "id": "641e15b7-a326-44b1-9ed2-536cd327101b",
    "object": "ledger",
    "name": "Business Ledger",
    "created_at": "2022-11-01T20:50:56Z",
    "updated_at": "2022-11-01T20:50:56Z"
  }
]