HMhm-land-registry
Notifications API

GET /v1/notifications

Changed on

Receive notifications API - Get any unacknowledged notifications

Request

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"
    }
  ]
}

Changes

  • 04719f6cbb9cRevision changes
    • info

      api operation id Receive notifications API removed and replaced with get_notifications_v1

  • 3a8f0dc06f13Revision changes
    • breaking

      for the query request parameter additional_provider_filter, the minLength was increased from 0 to 1

    • breaking

      added the pattern ^[A-Za-z0-9._@-]*$ to the query request parameter notification_type

    • breaking

      added the pattern ^[A-Za-z0-9._@-]*$ to the query request parameter subject

    • warning

      for the query request parameter additional_provider_filter, the maxLength was set to 50

    • warning

      for the query request parameter notification_type, the maxLength was set to 255

    • warning

      for the query request parameter subject, the maxLength was set to 64