API Reference

Search alerts

get
https://platform.{env}.simpplr.com/v1/alerts

Search api allows us to retrieves list of alerts, encompassing active, scheduled and expired alerts.

Query Params
int64

A limit on the number of alerts to return in a request.

string

Token for next page

string

Returns alerts based on the receiving audience. Allowed values: everyone , {site-id}

string

Search term

string
enum

Allows the alerts to be Sorted in order based on the created on or display timestamp.

Allowed:
string
enum
required
Defaults to all

Returns alerts based on the status of the alert. By default it is set to all.

Allowed:
Responses

Updated 4 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago