Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Notifications

Search and sort notifications by alertId, alertType, actorId, actorType, actorAccountId, category, and read. V1 notifications can be requested with includeV1Notifications.

get/notifications

Path parameters

userIdstring required

The unique identifier of the user

Query parameters

languagestring

Source data set is api/v3.0/languages

Example:en-US

Language query overrides Accept-Language header

timestamp__ltestring date-time

Filter by timestamp__lte

timestamp__gtestring date-time

Filter by timestamp__gte

alertIdstring uuid nullable
Example:16cf0993-9705-406f-a17b-92fbe6836247

Filter by alertId

alertTypestring

Filter by alertType

actorIdstring

Filter by actorId

actorTypestring

Filter by actorType

actorAccountIdstring

Filter by actorAccountId

category'health' | 'video' | 'operational' | 'audit' | 'job' | 'security' | 'sharing'

Filter by category

readboolean

Filter by read

status'pending' | 'bounced' | 'dropped' | 'deferred' | 'delivered' | 'sent' | 'outsideUsersSchedule' | 'notificationsDisabled' | 'noNotificationActions' | 'sendingFailed' | 'throttled' | 'unableToGetSettings'

Filter by status

includeV1Notificationsboolean

When set to true, includes v1 notifications in the response along with current notifications.

sortstring[]

Sort by timestamp

pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page for cassandra. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

Headers

Accept-Languagestring

Source data set is api/v3.0/languages

Example:en-US

Response

Notification results

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

Example response

{
  "results": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "timestamp": "2021-04-22T00:00:00.000+00:00",
      "createTimestamp": "2021-04-22T00:00:00.000+00:00",
      "sentTimestamp": "2021-04-22T00:00:00.000+00:00",
      "alertId": "16cf0993-9705-406f-a17b-92fbe6836247",
      "alertType": "lineCrossing",
      "actorId": "d22d1939-2e14-434b-8185-d324be6cf363",
      "actorName": "Front Door",
      "actorType": "device",
      "actorAccountId": "00011557",
      "userId": "ca0de584",
      "accountId": "00011557",
      "status": "sent",
      "description": "Line crossing detected on \"Front Door\"",
      "notificationActions": [
        "email",
        "push",
        "webapp",
        "gui",
        "sms"
      ]
    }
  ]
}