Get User Notifications

GET 
/api/v1/user/notifications

Notifications returned are limited to latest 100.

HTTP RESPONSE

Standard HTTP code and JSON payload as below.

{
  "notifications": [
    {
      "id": 2,
      "message": "Collection updated by joe@example.org",
      "url": "/collection/1",
      "disposal": "ON_ACK",
      "timestamp": "2022-05-14T07:08:49Z"
    },
    {
      "id": 1,
      "message": "Welcome! New notifications will appear here.",
      "url": null,
      "disposal": "ON_READ",
      "timestamp": "2022-05-15T07:08:15Z"
    }
  ]
}

Parameter	Details
id	Notification id, used for disposing
message	Notification text
url	Any associated URL
disposal	What should be done with the message. See below
timestamp	ISO 8601 datetime indicating when the notification was issued

Notifications have two disposals listed below.

Disposal type	Details
ON_READ	Disposed automatically when retrieved
ON_ACK	User must acknowledge the notification to dispose it

Responses

200

List of user notifications

401

Unauthorized

500

Internal server error