---
title: "List alarms"
method: GET
path: "/api/v2/alarms"
tags: ["Alarms"]
---

# List alarms

`GET /api/v2/alarms`

## Request

- Base URL: `https://gear.cloud.studio`
- URL: `https://gear.cloud.studio/api/v2/alarms`
- Auth: one of:
  - HTTP bearer
  - API key in query parameter `accessToken`

Send one, and only one, of `clientID`, `facilityID`, `deviceID` or `endpointID`.

## Query parameters

- `clientID` integer
- `facilityID` integer
- `deviceID` integer
- `endpointID` integer
- `dateFrom` string
- `dateTo` string
- `state` 'open' | 'closed' | 'all'
- `maxCount` integer

## Response `200`

Matching alarms.

- Alarm[]
  - `AlarmID` integer
  - `DeviceID` integer
  - `EndpointID` integer
  - `AlarmTypeID` integer
  - `AlarmTypeDescription` string
  - `AlarmSeverityID` 0 | 1 | 2 | 3: 0 information, 1 low, 2 medium, 3 high.
  - `AlarmSeverityDescription` string
  - `Details` string
  - `DateTimeCreated_UTC` string
  - `DateTimeClosed_UTC` string
  - `SequenceNumber` integer

## Other responses

- `500`: The request failed. A missing, invalid or expired access token is also reported this way.

---

[API](https://skmtc.dev/cloudstudioiot/apis/cloud-studio-iot-data-extraction-api.md) · [All operations](https://skmtc.dev/cloudstudioiot/apis/cloud-studio-iot-data-extraction-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cloudstudioiot/apis/cloud-studio-iot-data-extraction-api/revisions/1f497bcfbbb1?raw)