Skip to main content
GET
/
api
/
ledger
/
v2
/
{ledger}
Get a ledger
curl --request GET \
  --url http://localhost/api/ledger/v2/{ledger} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "name": "<string>",
    "addedAt": "2023-11-07T05:31:56Z",
    "bucket": "<string>",
    "metadata": {
      "admin": "true"
    },
    "features": {},
    "id": 123
  }
}

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 details about a specific ledger including its configuration and metadata.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
ledger
string
required

Name of the ledger.

Example:

"ledger001"

Response

OK

​
data
object
required