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

# List alerts

> Lists all alerts for the user's account. The response is paginated. The `q` search parameter searches across webpage configuration name, webpage URL, and alert ID.



## OpenAPI

````yaml /openapi.json get /api/v1/alerts
openapi: 3.0.3
info:
  title: WebOrion Monitor API
  description: >-
    REST API for managing webpages, alerts, batch jobs, and activity logs in
    WebOrion Defacement Monitor.
  version: '2021-07-26'
servers:
  - url: https://api.monitor.weborion.io
security:
  - bearerAuth: []
tags:
  - name: User
    description: Operations related to user accounts
  - name: Webpages
    description: Operations related to webpages and URLs
  - name: Batch Jobs
    description: Operations related to batch baseline and rebaseline jobs
  - name: Alerts
    description: Operations related to alerts
  - name: Domains
    description: Operations related to domains
  - name: Tags
    description: Operations related to tags for organising webpages
paths:
  /api/v1/alerts:
    get:
      tags:
        - Alerts
      summary: List alerts
      description: >-
        Lists all alerts for the user's account. The response is paginated. The
        `q` search parameter searches across webpage configuration name, webpage
        URL, and alert ID.
      operationId: listAlerts
      parameters:
        - in: query
          name: page
          schema:
            type: integer
          required: false
        - in: query
          name: items_per_page
          schema:
            type: integer
          required: false
        - in: query
          name: q
          schema:
            type: string
          required: false
          description: Search query — searches webpage name, URL, and alert ID
        - in: query
          name: start_date
          schema:
            type: string
          required: false
        - in: query
          name: end_date
          schema:
            type: string
          required: false
        - in: query
          name: start_id
          schema:
            type: integer
          required: false
        - in: query
          name: end_id
          schema:
            type: integer
          required: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndUserAlertCollection'
components:
  schemas:
    EndUserAlertCollection:
      type: object
      properties:
        current_page:
          type: integer
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              url:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                    description: Configuration name for the webpage as set in the portal
                  url:
                    type: string
                    description: URL of the webpage
              time_detected:
                type: string
                format: date-time
        first_page_url:
          type: string
        from:
          type: integer
        last_page:
          type: integer
        last_page_url:
          type: string
        next_page_url:
          type: string
        path:
          type: string
        per_page:
          type: integer
        prev_page_url:
          type: string
        to:
          type: integer
        total:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Generate an API token from the WebOrion Defacement Monitor portal. Pass
        it as `Authorization: Bearer <token>`.

````