---
title: "List the alerts"
method: GET
path: "/alerts"
tags: ["Alert"]
---

# List the alerts

`GET /alerts`

List a page of alerts by filter.

## Query parameters

- `page` integer
- `limit` integer
- `startTime` integer, required
- `endTime` integer, required
- `severityIds` integer[]
- `categoryIds` integer[]
- `messageMetadataIds` integer[]
- `acknowledged` boolean
- `siteId` integer
- `floorId` integer
- `buildingId` integer
- `keyword` string
- `sortField` 'TIMESTAMP' | 'SOURCE' — All available device sort fields<br/><br/>TIMESTAMP = Last Detected<br/> SOURCE = Source Name
- `order` 'ASC' | 'DESC' — Sort Order

## Response `200`

OK

- PagedXiqAlert
  - `page` integer, required — The current page number
  - `count` integer, required — The element count of the current page
  - `total_pages` integer, required — The total page number based on request page size
  - `total_count` integer, required — The total element count
  - `data` XiqAlert[] — The data in the current page
    - `id` string, required — The unique identifier
    - `owner_id` integer — The owner ID
    - `timestamp` string, date-time, required — The alert create time
    - `org_id` integer — The organization identifier, valid when enabling HIQ feature
    - `message_metadata_id` integer — The message metadata id
    - `message_metadata_type` string — The message metadata type
    - `message_metadata_name` string — The message metadata name
    - `summary` string — A high-level, text summary message of the event. Will be used to construct an alert's description.
    - `severity_name` string — The severity name of the alert
    - `category_name` string — The alert category name
    - `severity_id` integer — The severity Id of the alert
    - `category_id` integer — The alert category Id
    - `source` XiqAlertSource — The alert source info
      - `source_type_id` integer — The alert source type ID
      - `source_name` string — The alert source name
      - `source_type_name` string — The alert source type name
      - `source_id` string — The alert source ID
    - `tags` XiqAlertTag[], required — Additional information for the alert
      - `id` integer, required — The unique identifier for the tag metadata
      - `name` string — The tag display name.
      - `value` string — The tag value.
      - `is_hidden` boolean — If tag should be hidden from the user.
    - `acknowledged` boolean — The acknowledged status of alert
    - `site_id` integer — The site id of alert
    - `site_name` string — The site name of alert
    - `alert_policy_id` integer — The policy id of alert
    - `alert_policy_name` string — The policy name of alert
    - `alert_rule_id` integer — The rule id of alert
    - `acknowledged_username` string — The user's email who acknowledged
    - `floor_id` integer — The floor id of alert
    - `floor_name` string — The floor name of alert
    - `building_id` integer — The buiding id of alert
    - `building_name` string — The building name of alert

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)