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 blnk.Ledgers.get to retrieve a ledger by its ledger_id.
blnk.Ledgers.get
const response = await blnk.Ledgers.get(
  'ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb',
);
FieldTypeDescription
idstringLedger ID to retrieve.

​
Response shape

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"
  }
}
FieldDescription
ledger_idUnique ID for the ledger.
nameCurrent display name.
created_atDate and time the ledger was created.
meta_dataMetadata 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.