Skip to main content

Notifications

Notifications are sent to users to inform or notify them of actions that should be performed.

GET /api/v1/notifications​

Find notifications for the current user. The request parameters act as filters on the list.

Parameters​

  • to.userSource (optional) — Filter by user source system (available to support users only)
  • to.userId (optional) — Filter by user ids (available to support users only)
  • nature (optional) — Filter by the specified nature(s). Accepts multiple nature parameters.
  • type (optional) — Filter by specified type of notification.
  • topic (optional) — Filter by specified topic of notification.
  • includeRead (optional) — Include read notifications. Defaults to false.
  • includeUnread _(optional) — Include unread notifications. Defaults to true.
  • includeViewed (optional) — Include viewed notifications. Defaults to true.
  • includeUnviewed (optional) — Include unviewed notifications. Defaults to true.
  • includeInactive (optional) — Include inactive notifications. Defaults to false.
  • includeSources (optional) — Include notification sources. Defaults to false.
  • sortBy (optional) — Field to sort by. The default is 'lastDeliveryDate'.
  • sortDirection (optional) — Sort direction. The default is 'desc'.

Example Request​

GET https://apps.availity.com/api/notifications?type=PDM&includeRead=true

Example Response​

{
  "totalCount": 1,
  "count": 1,
  "offset": 0,
  "limit": 50,
  "links": {
    "self": {
      "href": "https://apps.availity.com/api/v1/notifications?type=PDM&includeRead=true"
    }
  },
  "notifications": [
    {
      "id": "83582901741516995037509300045112",
      "createdDate": "2018-01-26T19:31:03.000+0000",
      "updatedDate": "2018-03-02T16:20:08.000+0000",
      "nature": "Action Item",
      "type": "PDM",
      "subject": "Provider Data Management",
      "title": "Acme provider directory - We have not received your verified Q1 information.  Please submit!",
      "subtitle": "Quarterly submissions build trust with patients that your information is correct and reliable.",
      "message": "Acme provider directory - We have not received your verified Q1 information.  Please submit!",
      "link": "/public/apps/provider-self-service-maintenance/#/cms",
      "linkTarget": "_blank",
      "activeDate": "2018-03-01T19:30:31.000+0000",
      "expirationDate": "2018-03-30T04:00:00.000+0000",
      "lastDeliveryDate": "2018-03-01T19:30:32.000+0000",
      "topic": "PDM",
      "read": false,
      "viewed": true,
      "interruptIndicator": false
    }
  ]
}