Get List of Contingents

Get List of Contingents

GET https://api.maileon.com/partner/settings/prepaids/contingents?key={k}&nl_account_id={nlaId}

Description: Get a list of contingents.

Parameters:
– key: apikey
– nl_account_id: int // the id of the newsletter account
– status: Only events with status contained in this list are included in the result, if no list is provided all events are returned. Invalid status will be ignored. Valid: consumed, expired, running, outstandin

Returns:
– A list of contingents

Response-Codes:
– 200 – OK

Example:

GET https://api.maileon.com/partner/settings/prepaids/contingents?key={k}&nl_account_id={nlaId}
200 OK
x-items: 115
x-pages: 2
link: ; rel="start"; ; rel="next"
content-type: application/json
[
{
"expiryDate": "1970-01-01T01:00:00+01:00",
"contingentValue": 150000,
"availableValue": 0,
"newsletterAccountId": 12345,
"usedValue": 150000,
"author": "maxi.musterfrau@xqueue.com",
"created": "2017-02-22T15:26:48+01:00",
"name": "My contingent 20170222152648",
"id": 321,
"updated": "2017-02-22T16:23:23+01:00",
"status": "consumed"
},
{
"expiryDate": "2017-01-22T12:00:00+01:00",
"contingentValue": 500000,
"availableValue": 500000,
"newsletterAccountId": 1,
"usedValue": 0,
"author": "max.mustermann@xqueue.com",
"created": "2017-02-22T15:27:33+01:00",
"name": "prepaid contingent 20170222152733",
"id": 789,
"updated": "2017-02-22T15:33:34+01:00",
"status": "expired"
}
...
]

GET https://api.maileon.com/partner/settings/prepaids/contingents?key={k}&nl_account_id={nlaId}&status=running
200 OK
x-items:1
x-pages:1
link: ; rel="start"
content-type: application/json
[{
"expiryDate": "1970-01-01T01:00:00+01:00",
"contingentValue": 1000,
"availableValue": 990,
"newsletterAccountId": 12345,
"usedValue": 10,
"author": "max.mustermann@xqueue.de",
"created": "2017-11-02T10:20:05+01:00",
"name": "New Contingent 02.11.2017",
"id": 123,
"updated": "2017-12-12T18:11:00+01:00",
"status": "running"
}]