List alerts

Returns a page of alerts.

Request
query Parameters
providerId
string <uuid>

If set, the items will be filtered on provider with the specified identifier.

providerName
string
providerNpi
integer <int64>
type
Array of strings

If set, the items will be filtered on alerts of the specified type

Items Enum: "LicenseChanged" "LicenseExpiresSoon" "LicenseExpired" "ProfileImportCompleted"
status
string

If set, filter the items by the dismissal status.

Enum: "Active" "Dismissed"
sortDirection
string

The direction the returned data will be sorted by.

Enum: "Asc" "Desc"
providerDeactivated
boolean

If set, the items will be filtered on providers with the specified deactivated status.

sortedBy
string

The property by which the returned data will be sorted.

Value: "Timestamp"
object

If set, the properties and directions the returned data will be sorted by.

offset
integer <int32>
Deprecated

The offset for the page to start.

cursor
string

The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically.

count
integer <int32>

The number of items to include in a single page.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/alerts
Response samples
application/json
{
  • "previousCursor": "string",
  • "nextCursor": "string",
  • "nextOffset": 0,
  • "pageSize": 0,
  • "count": 0,
  • "totalCount": 0,
  • "items": [
    ],
  • "sortedBy": "Timestamp",
  • "sortDirection": "Asc",
  • "sort": {
    }
}