v8

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-17105598.9 KB
Notifications API

Receive notifications API - Get any unacknowledged notifications

get/v1/notifications

Query parameters

created_beforestring date-time
created_afterstring date-time
status'NEW' | 'ACKNOWLEDGED'
occurred_beforestring date-time
occurred_afterstring date-time
notification_typestring
subjectstring
additional_provider_filterstring
limitinteger

Response

List of notifications

Example response

{
  "data": [
    {
      "created_datetime": "2025-01-01T00:00:00Z",
      "event_datetime": "2025-01-01T00:00:00Z",
      "payload_schema": "https://example.com/",
      "notification_type": "TYPE_1",
      "subject_type": "subject_type",
      "subject": "subject"
    }
  ]
}