Retrieve alarms report email recipients

Retrieve a list of email addresses to which alarms reports are sent. Partners can receive a list of email addresses from a specific organization by providing the organization ID.

Request

Security:

bearerAuth

query Parameters

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

Responses

200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/recipients/alarms

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://api-prod.surfsight.net/v2/recipients/alarms?organizationId=17' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"data": [{"email": "email@email.com",
"reportIntervalSeconds": 3600,
"alarmDefinitions": [{"id": 625,
"name": "Hardware failure: Unable to start camera sensor and record video"
}
],
"id": 23,
"createdByAudienceName": "surfsight",
"createdById": 23,
"targetEntity": "organization",
"targetId": 27,
"lastReportAt": "2019-08-24T14:15:22Z"
}
]
}