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

# Read alert setting

> Returns which alert types your organization records and which of them are also sent as notifications. When nothing has been saved yet, every type is off (`false`) and every notification flag is on (`true`). Alert types not listed here, such as panic alerts, are always recorded and notified.

Requires permission `view/alertSetting`.



## OpenAPI

````yaml /openapi/public/openapi-monitoring.json get /alert-setting
openapi: 3.0.0
info:
  title: API - Monitoring
  version: 3.0.0
  description: API Documentation - RESTful API for field operations management.
servers:
  - url: https://apiweb.mile.app/api/v3
security:
  - bearerAuth: []
tags:
  - name: Alert
    description: >-
      An alert is an event raised while monitoring field users and vehicles, for
      example entering or leaving a geofence, idling too long, a predicted late
      task, a route deviation or a panic button press. You can list alerts, read
      a daily summary, and mark them resolved. These endpoints are served under
      `/api/v4`.
  - name: Alert Setting
    description: >-
      Alert settings switch each alert type on or off for your organization.
      These endpoints are served under `/api/v4`.
  - name: Geofence
    description: >-
      A geofence is an area drawn on the map, as a polygon or a circle. Alerts
      and automations can react when a field user enters or leaves it, or stays
      inside longer than its dwell time.
  - name: Geofence Group
    description: >-
      Geofence groups organize geofences so you can filter and manage them
      together.
paths:
  /alert-setting:
    servers:
      - url: https://apiweb.mile.app/api/v4
    get:
      tags:
        - Alert Setting
      summary: Read alert setting
      description: >-
        Returns which alert types your organization records and which of them
        are also sent as notifications. When nothing has been saved yet, every
        type is off (`false`) and every notification flag is on (`true`). Alert
        types not listed here, such as panic alerts, are always recorded and
        notified.


        Requires permission `view/alertSetting`.
      operationId: getAlertSetting
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Status of response.
                  message:
                    description: Message of API response.
                    type: string
                  data:
                    description: >-
                      Alert type flags, notification flags, `updatedBy` and
                      `updatedTime`.
                    type: object
                    additionalProperties: true
                example:
                  status: true
                  message: Success
                  data:
                    geofence: true
                    idle: true
                    lateness: false
                    routeDeviation: false
                    geofenceNotification: true
                    idleNotification: false
                    latenessNotification: true
                    routeDeviationNotification: true
                    updatedBy: admin@example.com
                    updatedTime: '2026-10-10T04:00:00.000Z'
      deprecated: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use a valid Bearer token to authenticate.

````

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