Skip to main content
GET
/
v1
/
notifications
List notifications
curl --request GET \
  --url https://api.example.com/v1/notifications \
  --header 'Authorization: <authorization>'

​
Overview

Returns a paginated list of notifications for the current user, including incident updates, approval requests, and system messages. Notifications are sorted by most recent first. Required role: admin or member

​
Request headers

​
Authorization
string
required
JWT Bearer token. Format: Bearer <your-jwt>.

​
Query parameters

​
read
boolean
Filter by read status. true returns only read notifications; false returns only unread.
​
type
string
Filter by notification type (e.g. incident.status_changed, approval.requested).
​
limit
integer
Maximum results. Default: 50. Maximum: 200.
​
cursor
string
Pagination cursor from a previous response.

​
Response

Returns 200 OK. 
{
  "items": [
    {
      "notificationId": "ntf_01HX9VTPQR3KF8MZWBYD5N6JCE",
      "type": "approval.requested",
      "title": "Approval required: Scale connection pool",
      "body": "AI has proposed scaling the payment processor connection pool from 50 to 150. Your approval is required before execution.",
      "read": false,
      "incidentId": "inc_EXAMPLE_01JX",
      "remediationId": "rem_01HX9VTPQR3KF8MZWBYD5N6JCE",
      "createdAt": "2024-04-01T14:35:00Z"
    }
  ],
  "unreadCount": 3,
  "nextCursor": null
}
FieldTypeDescription
notificationIdstringUnique notification identifier
typestringEvent type that generated this notification
titlestringShort notification title
bodystringFull notification message
readbooleanWhether the notification has been marked read
incidentIdstringRelated incident ID, if applicable
createdAtstringISO 8601 timestamp

​
Error responses

StatusError codeDescription
401unauthorizedMissing or invalid JWT

​
Examples

curl "https://api.causeflow.ai/v1/notifications?read=false" \
  -H "Authorization: Bearer eyJhbGc..."

Mark read

Mark notifications as read

SSE stream

Receive notifications in real time