---
title: "GET /alerts"
method: GET
path: "/alerts"
tags: ["Alerts"]
---

# GET /alerts

`GET /alerts`

## Request

- Base URL: `https://api.cxxx.eagleeyenetworks.com/api/v3.0`
- URL: `https://api.cxxx.eagleeyenetworks.com/api/v3.0/alerts`
- Auth: HTTP bearer

Search and sort alerts by creatorId, alertType, actorId, actorType, actorAccountId, ruleId, eventId, locationId, and priority. Optional information can be requested with include.

## Query parameters

- `language` string: Source data set is api/v3.0/languages
- `creatorId` string
- `timestamp__lte` string, date-time
- `timestamp__gte` string, date-time
- `alertType__in` string[]
- `actorId__in` string[]
- `actorType__in` string[]
- `actorAccountId` string
- `ruleId` string, uuid
- `ruleId__in` string[]
- `eventId` string
- `locationId__in` string[]
- `eventType__in` string[]
- `priority__gte` integer
- `priority__lte` integer
- `showInvalidAlerts` boolean
- `alertActionId__in` string[]
- `alertActionStatus__in` string[]
- `include` string[]
- `sort` string[]
- `pageToken` string
- `pageSize` integer

## Headers

- `Accept-Language` string: Source data set is api/v3.0/languages

## Response `200`

Alert results

- Alerts: Used to wrap results for a paginated response, containing information on how to retrieve further pages.
  - `nextPageToken` string, nullable, required: Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.
  - `prevPageToken` string, nullable, required: Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.
  - `results` object[], required: The result set from a collection API call.
    - `id` string, uuid
    - `timestamp` string, date-time
    - `createTimestamp` string, date-time
    - `creatorId` string
    - `alertType` string
    - `alertName` string
    - `category` string
    - `serviceRuleId` string: The UUID of the service rule id for creation.
    - `eventType` string
    - `actorId` string
    - `actorType` string
    - `actorAccountId` string
    - `actorName` string
    - `ruleId` string
    - `eventId` string
    - `locationId` string
    - `locationName` string, nullable
    - `priority` integer
    - `dataSchemas` string[]
    - `data` object
    - `actions` object
    - `description` string

## Other responses

- `400`: The supplied object is invalid. Error detail will contain the validation error.
- `401`: You are not authenticated. Please authenticate and try again.
- `403`: You have no permission to access the specified resource.
- `500`: Something went wrong in the server. Please try again.

---

[API](https://skmtc.dev/eagleeyenetworks/apis/events.md) - [All operations](https://skmtc.dev/eagleeyenetworks/apis/events/llms.txt) - [OpenAPI document](https://skmtc.dev/eagleeyenetworks/apis/events/revisions/3092457362ad?raw)