The GroupAlarm REST API

With the REST API, you couple your own systems to trigger the alarm up to the complete management of all entities.

Connect your own systems to GroupAlarm

With GroupAlarm’s REST API, you can connect your existing systems to GroupAlarm. This allows you, for example, to trigger alarms directly from your application and retrieve the feedback. Furthermore, you can address each individual service in GroupAlarm, e.g. manage participants, send data to alarm monitors, create appointments, …

Examples

Set feedback of a participant via API

1
2
3
4
5
6
7
8
9

curl --location --request POST 'https://app.groupalarm.com/api/v1/messaging/feedback' \
--header 'API-TOKEN: << API-TOKEN >>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "alarmID": 0,
  "organizationID": << ORGANISATION ID >>,
  "response": << true | false >>,
  "userID": << ID des Users >>
}'

Set position of a unit according to external ID

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

curl --location --request PUT 'https://app.groupalarm.com/api/v1/unit/externalID/position' \
--header 'API-TOKEN: << API-TOKEN >>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "externalID": " << EXTERNER BEZEICHNER DER EINHEIT>>",
  "organizationID": << ORGANISATION ID >>,
  "position": {
    "latitude": << LAT >>,
    "longitude": << LONG >
  }
}'

The GroupAlarm REST API

Documentation