Skip to content
Athena User Guide
Esc
↑↓navigate↵open⌘Jpreview

List event email deliveries and their outcomes, including terminal failures

GET/api/admin/notifications
Authorization
AuthorizationBearer token · headerrequired
Query parameters
statusstring
Allowed:pendingsentfailedexpiredskipped
Responses
200

Success

deliveriesobject[]required
Show properties
Array of object
idstringrequired
kindstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
createdAtstring<date-time>required
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
attemptsnumberrequired
lastErrorstring | nullrequired
Show properties
Any of:
string
string
null
null
sentAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
updatedAtstring<date-time>required
usernamestring | nullrequired
Show properties
Any of:
string
string
null
null
summaryobject[]required
Show properties
Array of object
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
totalnumberrequired
401

Unauthorized

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET '/api/admin/notifications' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "deliveries": [
    {
      "id": "string",
      "kind": "box_ready",
      "createdAt": "2019-08-24T14:15:22Z",
      "status": "pending",
      "attempts": 0,
      "lastError": "string",
      "sentAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "username": "string"
    }
  ],
  "summary": [
    {
      "status": "pending",
      "total": 0
    }
  ]
}