Skip to main content
GET
/
ledgers
/
{ledger_id}
Get ledger
curl --request GET \
  --url http://localhost:5001/ledgers/{ledger_id} \
  --header 'X-blnk-key: <api-key>'
Use client.Ledger.Get to retrieve a ledger by its ledger ID.
1

Call the method

client.Ledger.Get
ledger, resp, err := client.Ledger.Get(
	"ldg_049495c6-356e-4ebc",
)
FieldTypeDescription
idstringLedger ID to retrieve.
2

Use the ledger details

Read the returned ledger for the name, metadata, and creation time. Use these values to confirm you have the correct ledger before creating balances or transactions.
3

Response

200 OK
{
  "ledger_id": "ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb",
  "name": "Customer Checking Ledger",
  "created_at": "2024-11-26T08:23:57.509804Z",
  "meta_data": {
    "project_owner": "Blnk Tech"
  }
}
FieldTypeDescription
ledger_idstringUnique ID for the ledger.
namestringCurrent display name.
created_atstringDate and time the ledger was created.
meta_dataobjectMetadata object, if one was set at creation.

View ledger docs

Ledger concepts and setup.

View ledger details

HTTP request and response schema.

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.