Skip to main content
GET
/
ledgers
/
:id
curl -X GET https://YOUR_BLNK_INSTANCE_URL/ledgers/ldg_0a3b7c7e-e7a8-4f1e-9f6a-3d4c8b2e1a5f \
  -H 'X-Blnk-Key: YOUR_API_KEY'

{
  "ledger_id": "ldg_0a3b7c7e-e7a8-4f1e-9f6a-3d4c8b2e1a5f",
  "name": "Customer Wallets",
  "created_at": "2024-01-15T10:30:00Z",
  "meta_data": {
    "region": "US",
    "project_id": "proj_123"
  }
}
Retrieve the details of a specific ledger using its unique identifier.

​
Path Parameters

​
id
string
required
The unique identifier of the ledger to retrieve

​
Response

​
ledger_id
string
Unique identifier for the ledger
​
name
string
The name of the ledger
​
created_at
string
ISO 8601 timestamp of when the ledger was created
​
meta_data
object
Custom metadata associated with the ledger
curl -X GET https://YOUR_BLNK_INSTANCE_URL/ledgers/ldg_0a3b7c7e-e7a8-4f1e-9f6a-3d4c8b2e1a5f \
  -H 'X-Blnk-Key: YOUR_API_KEY'

{
  "ledger_id": "ldg_0a3b7c7e-e7a8-4f1e-9f6a-3d4c8b2e1a5f",
  "name": "Customer Wallets",
  "created_at": "2024-01-15T10:30:00Z",
  "meta_data": {
    "region": "US",
    "project_id": "proj_123"
  }
}

​
Usage Notes

  • The ledger ID must be provided in the URL path
  • Returns a 400 error if the ledger ID is not found in the system
  • Use this endpoint to verify ledger details before creating balances or accounts
  • The response includes all metadata stored with the ledger

Build docs developers (and LLMs) love

Get started for freeTalk to us