Skip to main content
GET
https://api.cloud.blnkfinance.com
/
data
/
ledgers
curl -X GET "https://api.cloud.blnkfinance.com/data/ledgers?instance_id=YOUR_INSTANCE_ID&page=1&pageSize=30" \
  -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN"

{
  "data": [
    {
      "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"
      }
    }
  ],
  "total": 5
}
Retrieve a paginated list of ledgers from your Blnk Core instance.
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?instance_id=YOUR_INSTANCE_ID&page=1&pageSize=30" \
  -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN"
​
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.
​
page
integer
Page number to retrieve. Defaults to 1.
​
pageSize
integer
Number of results per page. Defaults to 30 for ledgers.

​
Response structure

{
  "data": [
    {
      "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"
      }
    }
  ],
  "total": 5
}
​
data
array
required
Array of ledger objects.
​
total
integer
required
Total number of ledgers available.
For filters and supported fields, 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.