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

# List alerts

> Alerts across every vendor you monitor.

Returns the alert inbox for the authenticated user — the same feed shown in the dashboard's monitoring sidebar. Alerts are derived from monitoring events.

## Query parameters

<ParamField query="read" type="boolean">
  Filter by read state: `true` for read, `false` for unread. Omit to return all.
</ParamField>

<ParamField query="vendorId" type="string">
  Filter to alerts for a specific vendor.
</ParamField>

<ParamField query="severity" type="string">
  Filter by severity: `LOW`, `MEDIUM`, `HIGH`, or `CRITICAL`.
</ParamField>

<ParamField query="page" type="integer" default="1" />

<ParamField query="limit" type="integer" default="20">
  Max 100.
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://api.vouchmark.com/v1/monitoring/alerts?read=false" \
    -H "Authorization: Bearer $TOKEN"
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "success": true,
    "data": [
      {
        "alertId": "al_aBcD...",
        "customerId": "usr_aBcD...",
        "vendorId": "cmp_aBcD...",
        "vendorName": "TEKCIFY TECHNOLOGIES LTD",
        "eventId": "evt_aBcDeFgH...",
        "severity": "HIGH",
        "title": "TIN status changed",
        "message": "TIN status changed from ACTIVE to INACTIVE for TEKCIFY TECHNOLOGIES LTD.",
        "whatChanged": "TIN status changed from ACTIVE to INACTIVE",
        "monitoringUrl": "https://app.vouchmark.com/monitoring/vendors/cmp_aBcD...",
        "read": false,
        "createdAt": "2026-05-11T18:42:00Z",
        "updatedAt": "2026-05-11T18:42:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 1,
      "totalPages": 1
    }
  }
  ```
</ResponseExample>

## Mark as read

<ParamField path="alertId" type="string" required />

```bash theme={null}
curl -X PATCH https://api.vouchmark.com/v1/monitoring/alerts/al_aBcD.../read \
  -H "Authorization: Bearer $TOKEN"
```

Marks a single alert as read and returns the updated record.

<ResponseExample>
  ```json theme={null}
  {
    "success": true,
    "data": {
      "alertId": "al_aBcD...",
      "read": true,
      "updatedAt": "2026-05-12T09:15:00Z",
      "vendorId": "cmp_aBcD...",
      "eventId": "evt_aBcDeFgH..."
    }
  }
  ```
</ResponseExample>