HMhmrc
push-pull-notification-api

Get a list of notifications

Returns a list of notifications that have been sent to a box. <br><br>A maximum of 100 notifications will be returned. These will be ordered oldest first. <br><br>The OAuth bearer token used by this endpoint must have the scope read:pull-notifications.

get/misc/push-pull-notification/box/{boxId}/notifications

Request

Path parameters

boxIdstring required
Example:50dca3fc-c37c-4f03-b719-63571333624c

Unique identifier for a box

Query parameters

statusstring
Example:FAILED

Only return notifications with this status.<br>Either PENDING, FAILED or ACKNOWLEDGED.

fromDatestring
Example:2020-06-03T14:20:54.987

Only return notifications created after this datetime.<br>ISO-8601 UTC date and time.

toDatestring
Example:2020-06-03T14:20:54.987

Only return notifications created before this datetime.<br>ISO-8601 UTC date and time.

countinteger
Example:50

Only return count notifications.

Headers

Accept'application/vnd.hmrc.1.0+json' required

Specifies the response format and the version of the API to be used.

For example: application/vnd.hmrc.1.0+json

Response

OK

notificationIdstring required

Unique identifier for a notification.

boxIdstring required

Unique identifier for a box the notification was sent to.

messageContentType'application/json' | 'application/xml' required

Content type of the message.

messagestring required

The notification message defined by messageContentType (JSON or XML). If this is JSON then it will have been escaped. Details on the structure of this data can be found in the documentation for the HMRC API that created the notification.

status'PENDING' | 'FAILED' | 'ACKNOWLEDGED' required

Status of the notification.

createdDateTimestring required

ISO-8601 UTC date and time the notification was created.

Example response

[
  {
    "notificationId": "1ed5f407-8096-40d1-87ef-9a2a103eeb85",
    "boxId": "50dca3fc-c37c-4f03-b719-63571333624c",
    "messageContentType": "application/json",
    "message": "{\"key\":\"value\"}",
    "status": "PENDING",
    "createdDateTime": "2020-06-01T10:20:23.160+0000"
  },
  {
    "notificationId": "86bb5f82-452e-49c8-88af-1f321d573960",
    "boxId": "50dca3fc-c37c-4f03-b719-63571333624c",
    "messageContentType": "application/xml",
    "message": "<someXml>xmlValue</someXml>",
    "status": "PENDING",
    "createdDateTime": "2020-06-02T10:27:33.613+0000"
  }
]

Changes

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