> ## Documentation Index
> Fetch the complete documentation index at: https://help.gorelo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Lists alerts for the authenticated service provider.

> `Title` and `Message` are computed summaries of the alert.
            
`DismissedOn`/`DismissedBy` are populated only while an alert is dismissed,
            and record when and by whom it was dismissed.
            



## OpenAPI

````yaml /api-reference/openapi.json get /v1/alerts
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/alerts:
    get:
      tags:
        - Alerts
      summary: Lists alerts for the authenticated service provider.
      description: "`Title` and `Message` are computed summaries of the alert.\r\n            \n`DismissedOn`/`DismissedBy` are populated only while an alert is dismissed,\r\n            and record when and by whom it was dismissed.\r\n            "
      operationId: get_v1_alerts
      parameters:
        - name: Cursor
          in: query
          description: Cursor from a previous page.
          schema:
            type: string
        - name: PageSize
          in: query
          description: Alerts per page, 1-200. Defaults to 50.
          schema:
            type: integer
            format: int32
            default: 50
        - name: SortOrder
          in: query
          description: '`desc` (default, newest first) or `asc`. Sorted by `CreatedOn`.'
          schema:
            type: string
            default: desc
        - name: StatusIds
          in: query
          description: >-
            Comma-separated status ids: New=1, Dismissed=2, Ticketed=3. Any
            other id is a 400.
          schema:
            type: string
        - name: TypeIds
          in: query
          description: "Comma-separated type ids: Uptime=1, API=2, Script=3, External=4, Slide=5, Huntress=6,\r\nError Event Log=7, Disk Usage=8, Connectivity=9, Process=10, Service=11, Antivirus=12,\r\nRedfish=13, CPU=14, Memory=15, Ping=16, Windows Updates=17, Warranty Expiration=18,\r\nDomain Expiration=19, Contract Expiration=20. 7-17 are device-check alerts, identified by\r\ntheir check type rather than by how the alert was raised. 18-20 carry no device or check;\r\nContract and Domain carry a subject id, Warranty does not. 0 (N/A) matches an alert this scale cannot\r\nname. Any id outside 0-20 is a 400."
          schema:
            type: string
        - name: ClientIds
          in: query
          description: >-
            Comma-separated client ids. An alert type that carries no client id
            never matches this filter.
          schema:
            type: string
        - name: DeviceIds
          in: query
          description: >-
            Deprecated alias of agentAssetIds. Still accepted; ignored when
            agentAssetIds is supplied.
          schema:
            type: string
        - name: CreatedSince
          in: query
          description: Keeps only alerts raised at or after this instant (UTC).
          schema:
            type: string
            format: date-time
        - name: CreatedBefore
          in: query
          description: Keeps only alerts raised strictly before this instant (UTC).
          schema:
            type: string
            format: date-time
        - name: AgentAssetIds
          in: query
          description: Comma-separated agent asset ids (guids).
          schema:
            type: string
        - name: CustomAssetIds
          in: query
          description: >-
            Comma-separated custom asset ids (guids). Matches the alerts about a
            custom asset: `Warranty Expiration` alerts, and `API` alerts posted
            with a `CustomAssetId`.
          schema:
            type: string
        - name: UptimeIds
          in: query
          description: Comma-separated uptime ids (guids).
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AlertListItemModelListBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AlertListItemModelListBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AlertListItemModelListBaseResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    AlertListItemModelListBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          type: array
          items:
            $ref: '#/components/schemas/AlertListItemModel'
          nullable: true
        DataContext:
          $ref: '#/components/schemas/PaginationDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    AlertListItemModel:
      type: object
      properties:
        Id:
          type: string
          description: Alert identifier.
          format: uuid
        Title:
          type: string
          description: "The alert's subject, as the app's alert list shows it after the type - e.g.\r\n`\"Safari not found\"` for a Process alert, `\"Sentinel Agent Missing\"` for an\r\nAntivirus one, `\"Expires in 10 days\"` for an expiration."
        Type:
          $ref: '#/components/schemas/CodeModel'
        Severity:
          $ref: '#/components/schemas/CodeModel'
        Status:
          $ref: '#/components/schemas/CodeModel'
        Message:
          type: string
          description: The alert's message. Empty for uptime and external alerts.
        ClientId:
          type: integer
          description: "Identifier of the client the alert relates to. Null when the alert's type does not\r\ncarry a client (uptime, external and script alerts)."
          format: int64
          nullable: true
        AgentAssetId:
          type: string
          description: "Identifier of the agent asset the alert relates to - the id `GET /v1/assets/agents/{agentAssetId}`\r\ntakes. Null when there is none, and on an alert about a custom asset or an uptime."
          format: uuid
          nullable: true
        DeviceId:
          type: string
          description: "Identifier of the agent asset the alert relates to. <b>Deprecated:</b> use `AgentAssetId`,\r\nwhich has the same value."
          format: uuid
          nullable: true
          deprecated: true
        CustomAssetId:
          type: string
          description: "Identifier of the custom asset the alert relates to - the id `GET /v1/assets/custom/{customAssetId}`\r\ntakes. Set on a `Warranty Expiration` alert about a custom asset and on an `API` alert posted with a\r\n`CustomAssetId`; null on every other alert."
          format: uuid
          nullable: true
        CheckId:
          type: string
          description: "The check that raised this alert - a reusable check definition applied to devices\r\nthrough a policy, not a per-device record. Null on alerts not raised by one, including\r\nuptime alerts, which carry `UptimeId` instead."
          nullable: true
        UptimeId:
          type: string
          description: "The uptime that raised this alert, for `Uptime` alerts only - the same\r\nidentifier `GET /v1/uptime/{uptimeId}` takes. At most one of this and\r\n`CheckId` is set."
          format: uuid
          nullable: true
        UptimeCheckId:
          type: string
          description: >-
            The uptime that raised this alert. <b>Deprecated:</b> use
            `UptimeId`, which has the same value.
          format: uuid
          nullable: true
          deprecated: true
        TicketId:
          type: string
          description: >-
            Identifier of the ticket created from this alert. Null when no
            ticket has been created.
          format: uuid
          nullable: true
        ContractId:
          type: integer
          description: "The contract behind a `Contract Expiration` alert. Null on every other alert.\r\n            \r\n\n\r\nThe identifier `GET /v1/contracts/{contractId}` takes, so an expiration alert resolves\r\nto its contract without a second lookup.\r\n"
          format: int64
          nullable: true
        DomainId:
          type: integer
          description: "The web domain behind a `Domain Expiration` alert. Null on every other alert.\r\n            \r\n\n\r\nIdentifies the expiring domain, so it distinguishes - and lets a caller group - the many\r\nalerts a single domain produces as its expiry approaches.\r\n"
          format: int64
          nullable: true
        DismissedOn:
          type: string
          description: "When the alert was dismissed (UTC), or null when it is not dismissed. The same value the\r\napp shows under \"Dismiss - By/On\"."
          format: date-time
          nullable: true
        DismissedBy:
          type: integer
          description: "Identifier of the technician who dismissed the alert, or null when it is not dismissed.\r\nResolve it with the technician endpoint.\r\n            \r\n\n\r\nAlso null when the alert was dismissed automatically rather than by a person, so an\r\nauto-dismissal cannot currently be told apart from an unattributed one.\r\n"
          format: int64
          nullable: true
        CreatedOn:
          type: string
          description: When the alert was raised (UTC).
          format: date-time
        UpdatedOn:
          type: string
          description: When the alert was last updated (UTC).
          format: date-time
          nullable: true
      additionalProperties: false
      description: An alert as returned by the alert list endpoint. All timestamps are UTC.
    PaginationDataContext:
      type: object
      properties:
        Pagination:
          $ref: '#/components/schemas/PaginatedResponse'
      additionalProperties: false
      description: "The `DataContext` of a cursor-paginated success response: carries the paging metadata\r\nfor the returned page."
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
    CodeModel:
      type: object
      properties:
        Id:
          type: integer
          description: >-
            Numeric identifier of the coded value (e.g. status, priority, type,
            or source id).
          format: int64
          example: 1
        Name:
          type: string
          description: Display name of the coded value.
      additionalProperties: false
      description: >-
        A coded value, such as a status, priority, type or source, as an id and
        a display name.
    PaginatedResponse:
      type: object
      properties:
        NextCursor:
          type: string
          nullable: true
        PreviousCursor:
          type: string
          nullable: true
        HasMore:
          type: boolean
        HasPrevious:
          type: boolean
        TotalCount:
          type: integer
          format: int32
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.