Skip to main content
GET
/
ledgers
curl -X GET 'https://YOUR_BLNK_INSTANCE_URL/ledgers?limit=20&offset=0' \
  -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"
    }
  },
  {
    "ledger_id": "ldg_1b4c8d8f-f8b9-5g2f-0g7b-4e5d9c3f2b6g",
    "name": "Merchant Accounts",
    "created_at": "2024-01-16T14:22:00Z",
    "meta_data": {
      "region": "EU",
      "project_id": "proj_456"
    }
  }
]
Retrieve a list of all ledgers in the system with support for pagination and advanced filtering using query parameters.

​
Query Parameters

​
limit
integer
default:"10"
Maximum number of ledgers to return. Must be at least 1.
​
offset
integer
default:"0"
Number of ledgers to skip before starting to return results. Must be 0 or greater.

​
Advanced Filtering

You can filter ledgers using query parameters in the format field_operator=value. Available operators:
  • eq - Equal to
  • neq - Not equal to
  • gt - Greater than
  • gte - Greater than or equal to
  • lt - Less than
  • lte - Less than or equal to
  • like - Pattern matching (case-sensitive)
  • ilike - Pattern matching (case-insensitive)
​
name_eq
string
Filter by exact name match (e.g., name_eq=Customer Wallets)
​
name_ilike
string
Filter by name pattern (case-insensitive). Use % as wildcard (e.g., name_ilike=%wallet%)
​
created_at_gte
string
Filter ledgers created on or after this date (e.g., created_at_gte=2024-01-01)
​
created_at_lte
string
Filter ledgers created on or before this date (e.g., created_at_lte=2024-12-31)

​
Response

Returns an array of ledger objects.
​
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?limit=20&offset=0' \
  -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"
    }
  },
  {
    "ledger_id": "ldg_1b4c8d8f-f8b9-5g2f-0g7b-4e5d9c3f2b6g",
    "name": "Merchant Accounts",
    "created_at": "2024-01-16T14:22:00Z",
    "meta_data": {
      "region": "EU",
      "project_id": "proj_456"
    }
  }
]

​
Usage Notes

  • Default pagination returns 10 ledgers at a time
  • The limit parameter must be at least 1, and offset must be 0 or greater
  • Results are sorted by modification time when filters are applied
  • Use the offset parameter to implement pagination by incrementing it by the limit value
  • Filter operators are case-sensitive in the parameter name (e.g., use name_ilike not name_ILIKE)
  • When using like or ilike operators, use % as a wildcard character
  • Multiple filters can be combined in a single request
  • Date filters should use ISO 8601 format (YYYY-MM-DD or full timestamp)
  • If no filters are provided, all ledgers are returned with basic pagination

Build docs developers (and LLMs) love

Get started for freeTalk to us