Notifications API

GET /v0/notifications

Receive notifications API - Get any unacknowledged notifications

Request

Base URL
https://businessgateway.landregistry.gov.uk/bg2/api
Auth
HTTP basic
TypeScript
https://skmtc.dev/hm-land-registry/apis/v0-3-submit-an-application-to-change-the-land-register-api-s/docs/v0/notifications/get.ts
A function with typed inputs. Its response is checked against the schema.

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

No recorded changes to this operation across all 1 revision of this API.