See the details of one or all ledgers.
curl --request GET \
--url http://localhost:5001/ledgers/{ledger_id} \
--header 'X-blnk-key: <api-key>'
[
{
"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"
}
},
{
"ledger_id": "ldg_845e6b1e-0463-4ce8-b858-2b3a398beff9",
"name": "Customer Savings Ledger",
"created_at": "2024-11-26T08:23:46.171319Z",
"meta_data": {
"project_owner": "Blnk Tech"
}
},
{
"ledger_id": "general_ledger_id",
"name": "General Ledger",
"created_at": "2024-09-27T10:58:22.112739Z",
"meta_data": {}
}
]
X-blnk-key: <api-key>.
Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.
See also: Secure your Blnk server
ledger_id of the ledger being retrieved. Leave empty to view all ledgers in your Blnk Ledger.curl --request GET \
--url http://localhost:5001/ledgers/{ledger_id} \
--header 'X-blnk-key: <api-key>'
[
{
"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"
}
},
{
"ledger_id": "ldg_845e6b1e-0463-4ce8-b858-2b3a398beff9",
"name": "Customer Savings Ledger",
"created_at": "2024-11-26T08:23:46.171319Z",
"meta_data": {
"project_owner": "Blnk Tech"
}
},
{
"ledger_id": "general_ledger_id",
"name": "General Ledger",
"created_at": "2024-09-27T10:58:22.112739Z",
"meta_data": {}
}
]
Was this page helpful?
curl --request GET \
--url http://localhost:5001/ledgers/{ledger_id} \
--header 'X-blnk-key: <api-key>'
[
{
"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"
}
},
{
"ledger_id": "ldg_845e6b1e-0463-4ce8-b858-2b3a398beff9",
"name": "Customer Savings Ledger",
"created_at": "2024-11-26T08:23:46.171319Z",
"meta_data": {
"project_owner": "Blnk Tech"
}
},
{
"ledger_id": "general_ledger_id",
"name": "General Ledger",
"created_at": "2024-09-27T10:58:22.112739Z",
"meta_data": {}
}
]