---
title: "GET /v1/notifications"
method: GET
path: "/v1/notifications"
tags: ["Notifications API"]
---

# GET /v1/notifications

`GET /v1/notifications`

## Request

- Base URL: `https://businessgateway.landregistry.gov.uk/bg2/api`
- URL: `https://businessgateway.landregistry.gov.uk/bg2/api/v1/notifications`
- Auth: HTTP basic

Receive notifications API - Get any unacknowledged notifications

## Query parameters

- `created_before` string, date-time
- `created_after` string, date-time
- `status` 'NEW' | 'ACKNOWLEDGED'
- `occurred_before` string, date-time
- `occurred_after` string, date-time
- `notification_type` string
- `subject` string
- `additional_provider_filter` string
- `limit` integer

## Response `200`

List of notifications

- object
  - `data` NotificationResponse[]
    - `notification_id` string, uuid: The unique identifier of the notification
    - `created_datetime` string, date-time: Date and time the notification was created
    - `event_datetime` string, date-time: Date and time the event occurred
    - `payload_schema` string, uri: A link to a resource that describes the schema of the payload, this could be a JSON schema or documentation for example
    - `notification_type` string: The type of notification, required to distiguish notification types that share a schema
    - `subject_type` string: An indicator for the type of the subject
    - `subject` string: Unique reference to the subject of the notification
    - `additional_provider_filter` string: Provides additional filtering for larger integrators
    - `status` 'NEW' | 'ACKNOWLEDGED'
    - `payload` object: The payload of the notification

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Server Error

## Changes

- **2025-11-07** `04719f6cbb9c`: 1 info
  - api operation id `Receive notifications API` removed and replaced with `get_notifications_v1`
- **2025-10-31** `3a8f0dc06f13`: 3 breaking, 3 warning
  - for the `query` request parameter `additional_provider_filter`, the minLength was increased from `0` to `1`
  - added the pattern `^[A-Za-z0-9._@-]*$` to the `query` request parameter `notification_type`
  - added the pattern `^[A-Za-z0-9._@-]*$` to the `query` request parameter `subject`
  - for the `query` request parameter `additional_provider_filter`, the maxLength was set to `50`
  - …2 more

[Operation history](https://skmtc.dev/hm-land-registry/apis/v1-0-submit-an-application-to-change-the-land-register-api-s/changes/v1/notifications/get.md)

---

[API](https://skmtc.dev/hm-land-registry/apis/v1-0-submit-an-application-to-change-the-land-register-api-s.md) - [All operations](https://skmtc.dev/hm-land-registry/apis/v1-0-submit-an-application-to-change-the-land-register-api-s/llms.txt) - [OpenAPI document](https://skmtc.dev/hm-land-registry/apis/v1-0-submit-an-application-to-change-the-land-register-api-s/revisions/6964bf9fc289?raw)