Skip to main content
GET
/
balance-monitors
List balance monitors
curl --request GET \
  --url http://localhost:5001/balance-monitors \
  --header 'X-blnk-key: <api-key>'
Use blnk.BalanceMonitor.list to retrieve all balance monitors.
blnk.BalanceMonitor.list
const response = await blnk.BalanceMonitor.list();
This method takes no arguments.

​
Response shape

200 OK
[
  {
    "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0",
    "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
    "condition": {
      "field": "credit_balance",
      "operator": ">",
      "value": 1000,
      "precision": 100
    },
    "call_back_url": "https://api.example.com/balance-monitor",
    "description": "Low balance alert",
    "created_at": "2024-02-20T05:56:58.257315054Z"
  }
]
FieldDescription
response.dataArray of balance monitor objects.

Balance monitoring

Conditions and webhook behavior.

View balance monitor details

HTTP request and response schema.

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.