Skip to main content
GET
/
intelligence
/
alerts
List Alerts
curl --request GET \
  --url http://api.gu1.ai/intelligence/alerts \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "alerts": [
    {}
  ],
  "count": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.gu1.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Retrieves alerts for specific entities or across the organization. Alerts are generated automatically by rules when conditions are met.

​
Endpoint

GET http://api.gu1.ai/intelligence/alerts

​
Authentication

Requires a valid API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY

​
Query Parameters

​
entityId
string
required
Entity ID to filter alerts (person, company, or transaction)
​
status
string
Filter by status: PENDING, ACKNOWLEDGED, RESOLVED
​
severity
string
Filter by severity: LOW, MEDIUM, HIGH, CRITICAL
​
category
string
Filter by alert category

​
Response

​
success
boolean
Whether the request was successful
​
alerts
array
Array of alert objects
​
count
number
Total number of alerts matching filters

​
Example Requests

​
Get Alerts for Entity

curl -X GET "http://api.gu1.ai/intelligence/alerts?entityId=550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Filter by Severity and Status

curl -X GET "http://api.gu1.ai/intelligence/alerts?entityId=550e8400-e29b-41d4-a716-446655440000&severity=CRITICAL&status=PENDING" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response Example

{
  "success": true,
  "alerts": [
    {
      "id": "alert-uuid-123",
      "name": "High Risk Transaction Pattern",
      "category": "transaction_monitoring",
      "severity": "CRITICAL",
      "status": "PENDING",
      "createdAt": "2024-12-23T10:00:00.000Z",
      "updatedAt": "2024-12-23T10:00:00.000Z",
      "riskContribution": 25,
      "miniAnalysis": "Multiple high-value transactions detected within short timeframe",
      "investigationId": null,
      "targetEntityId": "550e8400-e29b-41d4-a716-446655440000",
      "triggerCondition": {
        "ruleName": "Rapid Transaction Detection",
        "threshold": 5,
        "actual": 8
      },
      "sourceSystem": "rules_engine"
    }
  ],
  "count": 1
}

​
Alert Severity Levels

  • LOW: Informational, requires review
  • MEDIUM: Moderate risk, should be investigated
  • HIGH: Significant risk, requires immediate attention
  • CRITICAL: Severe risk, urgent action required

​
Alert Status Workflow

  1. PENDING: Alert just created, awaiting review
  2. ACKNOWLEDGED: Alert has been reviewed by compliance team
  3. RESOLVED: Alert has been addressed and closed

​
See Also