Skip to main content
GET
/
notifications
/
undelivered
Get Undelivered Notifications
curl --request GET \
  --url https://api.decodahealth.com/notifications/undelivered \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "id": "<string>",
    "read": true,
    "createdDate": "2023-11-07T05:31:56Z",
    "alert": {
      "type": "PATIENT_CREATED",
      "content": ""
    }
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
limit
integer
default:50

Maximum notifications to return

Required range: x <= 100

Response

Successful Response

​
id
string
required
​
read
boolean
required
​
createdDate
string<date-time>
required
​
alert
NotificationAlertSummary · object
required

Lightweight alert info for notification list views.

Only the fields the notification UI actually needs — avoids validating the full alert data payload which varies by alert type.