GEgetlago
wallets

List wallet alerts

Changed on

This endpoint enables the retrieval of all alerts for a wallet.

get/customers/{external_customer_id}/wallets/{wallet_code}/alerts

Request

Query parameters

pageinteger
Example:1

Page number. Defaults to 1. A value that is not a positive integer, such as 0, returns the first page.

per_pageinteger
Example:20

Number of records per page. Defaults to 100. The maximum is 200, unless another maximum is configured for your organization. A value above the maximum returns a 422 error with value_is_out_of_range on per_page. A value that is not a positive integer, such as 0, returns the default number of records.

Response

Wallet alerts

Example response

{
  "alerts": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "lago_organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "lago_wallet_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "wallet_code": "wallet_code",
      "alert_type": "wallet_balance_amount",
      "code": "wallet_balance_alert",
      "name": "Wallet Balance Alert",
      "direction": "decreasing",
      "previous_value": "1000.0",
      "last_processed_at": "2025-05-19T10:04:21Z",
      "thresholds": [
        {
          "code": "warn",
          "notify_on": [
            "triggered",
            "resolved"
          ],
          "value": "99.0"
        }
      ],
      "created_at": "2025-03-20T10:00:00Z"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

Changes

  • 5d26657495a3Revision changes
    • breaking

      the // response's property type changed from number to string for status

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page

    • info

      added the optional property //////// to the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the ///// response's property pattern was changed from ^[0-9]+.?[0-9]*$ to ^-?[0-9]+(\.[0-9]+)?$ for the status