Skip to main content
GET
/
v1
/
notifications
List notifications
curl --request GET \
  --url https://api.example.com/v1/notifications

​
Overview

Returns a paginated list of notifications for the currently authenticated user. Notifications include investigation progress updates, remediation proposals requiring approval, and incident status changes. Required role: admin or member

​
Query parameters

​
status
string
default:"all"
Filter by read status. One of: unread, read, all.
​
limit
integer
default:"20"
Number of notifications to return per page. Maximum 100.
​
cursor
string
Cursor token from a previous response to fetch the next page. Omit for the first page.

​
Response

Returns 200 OK with a paginated list of notifications. 
{
  "notifications": [
    {
      "id": "ntf_01HX9VTPQR3KF8MZWBYD5N6JCE",
      "type": "approval.requested",
      "message": "Remediation 'Scale payment processor connection pool from 50 to 150' requires your approval.",
      "status": "unread",
      "incidentId": "inc_01HX9VTPQR3KF8MZWBYD5N6JCE",
      "remediationId": "rem_01HX9VTPQR3KF8MZWBYD5N6JCE",
      "createdAt": "2024-04-01T14:35:05Z"
    },
    {
      "id": "ntf_01HX9VTPQR3KF8MZWBYD5N6JCF",
      "type": "investigation.completed",
      "message": "Investigation complete for 'Database latency spike on prod-db-01'. Root cause identified with 94% confidence.",
      "status": "read",
      "incidentId": "inc_01HX9VTPQR3KF8MZWBYD5N6JCF",
      "remediationId": null,
      "createdAt": "2024-04-01T13:10:00Z"
    }
  ],
  "unreadCount": 3,
  "cursor": "eyJpZCI6Im50Zl8..."
}
FieldTypeDescription
idstringUnique identifier for the notification
typestringNotification type (matches SSE event types)
messagestringHuman-readable notification message
statusstringRead status: unread or read
incidentIdstringAssociated incident identifier. May be null for system notifications
remediationIdstringAssociated remediation identifier. null if not remediation-related
createdAtstringISO 8601 timestamp when the notification was created
unreadCountintegerTotal number of unread notifications for the user across all pages
cursorstringCursor token for the next page. null if no more pages.

​
Examples

# Fetch unread notifications
curl "https://api.causeflow.ai/v1/notifications?status=unread&limit=20" \
  -H "Authorization: Bearer <token>"