REreveldigital
Alerts

Gets all alerts for the account.

get/alerts

Request

  • Base URL
    https://api.reveldigital.com
  • Auth
    • OAuth 2
      Authorization codehttps://id.reveldigital.com/connect/authorize
      Token URLhttps://id.reveldigital.com/connect/token
      Scopeswebapi
    • or API key in header X-RevelDigital-ApiKey
    • or API key in query parameter api_key
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

idstring

Unique identifier for the alert (encrypted)

device_idstring[]

Filter by device IDs (encrypted)

active_onlyboolean

Filter to show only active alerts (not resolved and not snoozed)

resolvedboolean

Filter by resolved state

org_idstring

Filter by organization ID (encrypted)

takeinteger

Maximum number of items to retrieve

pageinteger

Page number for pagination

Response

OK

idstring nullable

The alert id (encrypted)

created_onstring date-time

The date and time the alert was created

updated_onstring date-time nullable

The date and time the alert was last updated

snoozed_untilstring date-time nullable

The date and time until which the alert is snoozed

resolved_onstring date-time nullable

The date and time the alert was resolved

is_activeboolean

Indicates if the alert is currently active (not resolved and not snoozed)

Changes

No recorded changes to this operation across all 3 revisions of this API.