List Alerts
Request URL
GET /alerts
Description
This API gets an array of all alerts that are enabled for the current user.
Snippet Examples
javascript
const axios = require('axios');
const config = {
method: 'GET',
url: '${AMPLIFI_BASE_URL}/alerts',
headers: {
'token': "A long random string token received from /token request"
},
};
let result;
try {
result = await axios.request(config);
if (result.status === 200) {
console.log(JSON.stringify(result.data));
}
} catch (err) {
console.log({
errCode: err.code,
responseStatus: err.response && err.response.status,
data: err.response && JSON.stringify(err.response.data)
});
}
cURL
curl --location "AMPLIFI_BASE_URL/alerts" --header "token: A long random string token received from /token request"
Successful Response Examples
200 ALERTS SUCCESSFUL RESPONSE RETRIEVING ALERTS
HEADERS
Header | Value |
---|---|
token | A long random string token received from /token request |
REQUEST BODY
RESPONSE BODY
{
"alerts": [
{
"alertTypeId": "alert1",
"category": "general",
"name": "Credit",
"isEnabled": true,
"descriptionOn": "On every incoming transfer",
"descriptionOff": "On every incoming transfer"
},
{
"alertTypeId": "alert2",
"category": "general",
"name": "Purchase",
"isEnabled": true,
"descriptionOn": "When any card is used at a store",
"descriptionOff": "When any card is used at a store"
},
{
"alertTypeId": "alert21",
"category": "general",
"name": "Debit",
"isEnabled": false,
"descriptionOn": "When money leaves my account",
"descriptionOff": "When money leaves my account"
},
{
"alertTypeId": "alert4",
"name": "Loans due",
"category": "general",
"isEnabled": true,
"descriptionOn": "When loans are due",
"descriptionOff": "When loans are due"
},
{
"alertTypeId": "summaryReportsMonthly",
"name": "Monthly",
"category": "summaryReports",
"isEnabled": false
},
{
"alertTypeId": "summaryReportsQuarterly",
"name": "Quarterly",
"category": "summaryReports",
"isEnabled": false
},
{
"alertTypeId": "summaryReportsAnnually",
"name": "Annually",
"category": "summaryReports",
"isEnabled": true
}
],
"success": true
}