Skip to main content
POST
/
v1
/
customer-alerts
/
list
Get all threshold notifications
curl --request POST \
  --url https://api.metronome.com/v1/customer-alerts/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_id": "9b85c1c1-5238-4f2a-a409-61412905e1e1"
}'
{
  "data": [
    {
      "customer_status": "in_alarm",
      "alert": {
        "id": "8deed800-1b7a-495d-a207-6c52bac54dc9",
        "name": "Low credit balance alert",
        "uniqueness_key": "823j7fqzo1",
        "type": "low_credit_balance_reached",
        "status": "enabled",
        "credit_type": {
          "id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
          "name": "USD (cents)"
        },
        "threshold": 0,
        "updated_at": "2022-01-01T00:00:00Z"
      }
    },
    {
      "customer_status": "ok",
      "alert": {
        "id": "3d45fdc3-e237-4acd-a7d9-ccfeb40e71b8",
        "name": "Spend threshold alert",
        "type": "spend_threshold_reached",
        "status": "enabled",
        "credit_type": {
          "id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
          "name": "USD (cents)"
        },
        "threshold": 1000,
        "updated_at": "2022-01-01T00:00:00Z"
      }
    }
  ],
  "next_page": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
next_page
string

Cursor that indicates where the next page of results should start.

Body

application/json

The threshold notifications query to run

​
customer_id
string<uuid>
required

The Metronome ID of the customer

​
alert_statuses
enum<string>[]

Optionally filter by threshold notification status. If absent, only enabled notifications will be returned.

Minimum length: 1

Response

200 - application/json

Success

​
data
object[]
required
​
next_page
string | null
required