Skip to main content
POST
/
api
/
alertmonitoring
/
orgStatus
Get organization status
curl --request POST \
  --url https://api2.rhombussystems.com/api/alertmonitoring/orgStatus \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "includeDeleted": false
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "locationStatuses": {},
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request to retrieve alarm monitoring status for all locations in an organization.

​
includeDeleted
boolean | null

If true, includes alert monitoring settings that were soft deleted in the response.

Example:

false

Response

200 - application/json

OK

Response containing alarm monitoring status for all locations in an organization.

​
error
boolean | null
​
errorMsg
string | null
​
locationStatuses
object

Map of location UUIDs to their monitoring enable status

​
warningMsg
string | null