Retrieve alarms report

Retrieve a list of the alarms from your devices. Partners can receive a list of alarms from a specific organization by providing the organization ID.

Request
Security:
query Parameters
limit
string^[1-9]\d*$
Default: "0"

Set the maximum number of pagination results to receive.

Example: limit=1
offset
string^[1-9]\d*$
Default: "0"

Set the number of results to skip over before receiving pagination results.

Example: offset=1
organizationId
string (Organization ID as string) ^[1-9]\d*$

Filter by the ID of the partner’s organization. Obtain this from GET /organizations. This is an optional parameter for partners.

Example: organizationId=17
imei
string

Filter by the IMEI number of the device. The IMEI number can be found on a sticker on the device or on the back of the device box.

Example: imei=12345678
name
string

Filter by the name of the user.

Example: name=Mike
alarmDefinitionName
string (Filter by the name of the alarm.) >= 2 characters

Filter by the name of the alarm.

alarmDefinitionSeverity
string (Alarm severity)

Filter by the severity of the alarm.

10 is the lease severe, and 60 is the most severe.

Enum: "10" "20" "30" "40" "50" "60"
read
string (Read)

Filter for alarms that are read.

unread
string (Unread)

Filter for alarms that are unread.

open
string (Open)

Filter for alarms that are open.

close
string (Close)

Filter for alarms that are closed.

sort
string (Sort for alarms)

Sort alarms by specific parameters, such as device names or IMEI numbers.

Enum: "name" "imei" "organizationName" "partnerName" "alarmDefinitionSeverity" "alarmDefinitionName" "createdAt"
order
string (Order)
Default: "desc"

Set the order that pagination results appear in - ascending or descending order.

Enum: "asc" "desc"
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/alarms
Request samples
curl -i -X GET \
  'https://api-prod.surfsight.net/v2/alarms?limit=1&offset=1&organizationId=17&imei=12345678&name=Mike&alarmDefinitionName=string&alarmDefinitionSeverity=10&read=string&unread=string&open=string&close=string&sort=name&order=asc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}