---
title: "Get alarm events"
method: GET
path: "/orgs/{orgId}/reports/alarm/events"
tags: ["orgs/reports"]
---

# Get alarm events

`GET /orgs/{orgId}/reports/alarm/events`

Returns alarm events for the `uiData.time` specified date range. This API can handle large date range requests. If not specified, the default search time span is 24 hours ago to now.<br/><br/>To filter by time, use a `filter` value of `uiData.time:(utcEpochSeconds-<utcEpochSeconds)` or any other valid time range specification, where utcEpochSeconds is replaced by your desired start and end times in unix epoch seconds. New partial results are returned for each API call. The query is complete when the API returns `false` for `cursors.hasNextPage`. The caller is required to pass the same filter parameter across all calls of the same query.<br/><br/>Commonly, the `limit` parameter provides an upper bound on the number of results returned by the API. That is not the case here. For performance reasons, this API endpoint treats the `limit` parameter as a suggestion. This endpoint commonly returns substantially more results than the specified `limit` value.<br/><br/>The `uiDataOnly` option will cause only uiData elements to be returned, filtering out the hookEvents sub-object from the response. This can reduce client JSON processing time and memory utilization if uiData is only needed.<br/><br/>The entryName2 and siteName2 fields can potentially return "Multiple" as the name. This occurs when the entries indicate multiple unique ids for that resource type. Whereas the entryId and siteId values will always equal their first entry or site value.<br/><br/>For traceability purposes, it is helpful if your API always provides the `option` parameter value of `searchId:{shortPurpose}-{orgId}-{startTimeMillisecs}-{callNum}`. Where `{shortPurpose}` might be `logGather` or whatever unique purpose you have in calling the API; `{orgId}` is your orgId; `{startTimeMillisecs}` is the time in milliseconds for the first call and remains unchanged for all `{callNum}` calls; `{callNum}` starts at 0 and increments for each API call when paging through each returned cursor until complete. An example the first call to this API might have a `searchId:logGather-12345-1675964642144-0` for the logGather purpose, 12345 orgId, with the first API call at 2023-02-09T17:44:02.144, and a 0 callNum for the 1st API call. The second API call with the cursor set would be `searchId:logGather-12345-1675964642144-1`, the 3rd call `...642144-2` and so on. Providing your searchId to an Openpath representative can significantly aid in resolving inqueries.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptAlarm:w,o{params.orgId}-rptAlarm:r,o:w,o:r<br/><br/>__Endpoint name__: getAlarmEvents

## Path parameters

- `orgId` integer, required

## Query parameters

- `limit` integer
- `cursor` string
- `filter` string
- `options` string
- `customFieldIds` integer[]

## Headers

- `x-op-debug` string

## Response `200`

Successful

- object
  - `totalCount` integer
  - `filteredCount` integer
  - `cursors` object
    - `nextCursor` integer, nullable
    - `hasNextPage` boolean
  - `data` object[]
    - `uiData` object
      - `alarmId` string, required
      - `time` number, required
      - `timeIsoString` string
      - `sourceEventTime` number, required
      - `sourceEventTimeIsoString` string
      - `subCategory` string, nullable
      - `userId` number, nullable
      - `userName` string, nullable
      - `acuId` number, nullable
      - `acuName` string
      - `entryId` number, nullable
      - `entryName2` string
      - `zoneId` number, nullable
      - `zoneName2` string, nullable
      - `siteId` number, nullable
      - `siteName2` string, nullable
      - `readerId` number, nullable
      - `readerName` string
      - `alarmActionId` number, required
      - `alarmActionName` string
      - `alarmStatusId` number, required
      - `alarmStatusName` string
      - `alarmConfigId` number, nullable
      - `alarmConfigName` string
      - `assignedUserId` number, nullable
      - `assignedUserName` string, nullable
      - `assignedRoleId` number, nullable
      - `assignedRoleName` string, nullable
      - `cameraIds` number[], nullable
      - `note` string
    - `hookEvent` object
      - `timestamp` number, required
      - `event` string, required
      - `data` object, required
  - `meta` object
    - `accessToken` object, nullable
      - `scopeUpdatedAt` string, date
    - `siteSpecificAccess` object, nullable
      - `isSiteSpecific` boolean
      - `siteIds` integer[], nullable
      - `siteIdsByScope` object, nullable
        - `string` integer[], nullable

---

[API](https://skmtc.dev/openpath/apis/openpath-api-documentation.md) · [All operations](https://skmtc.dev/openpath/apis/openpath-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openpath/openpath-api-documentation/revisions/d8a888c114fa/schema)