Skip to main content
GET
https://api.cloud.blnkfinance.com
/
data
/
ledgers
/
{ledger_id}
curl -X GET "https://api.cloud.blnkfinance.com/data/ledgers/ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc?instance_id=YOUR_INSTANCE_ID" \
  -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN"

{
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "MyApp Integration Ledger",
  "created_at": "2024-02-20T05:28:03.558281542Z",
  "meta_data": {
    "description": "Ledger for integration test"
  }
}
Retrieve details for a specific ledger by its ID.
For in-depth information about Blnk’s ledger, balance, transaction, and identity APIs, see the Blnk Core docs.

​
Request structure

curl -X GET "https://api.cloud.blnkfinance.com/data/ledgers/ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc?instance_id=YOUR_INSTANCE_ID" \
  -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN"
​
ledger_id
string
required
Unique identifier of the ledger to retrieve.
​
Authorization
string
required
Bearer token for authentication. Format: Bearer <access_token>. Your OAuth key must include data:read scope (or *).

​
Query parameters

​
instance_id
string
required
The Blnk Core instance ID to read from. Find this in Blnk Cloud under Instances.

​
Response structure

{
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "MyApp Integration Ledger",
  "created_at": "2024-02-20T05:28:03.558281542Z",
  "meta_data": {
    "description": "Ledger for integration test"
  }
}
​
ledger_id
string
required
Unique identifier for the ledger.
​
name
string
required
Name of the ledger.
​
created_at
timestamp
required
ISO 8601 formatted timestamp of when the ledger was created.
​
meta_data
object
Metadata object attached to the ledger, if any.
For filter queries and supported operators, see the Data API docs.

​
Need help?

If you’re having trouble with Blnk Cloud, don’t hesitate to send us a message via email at [email protected] or send us a message here.