Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Alerts

List Alerts (GET alias for POST /list).

List alerts with pagination and filtering.

get/v1/alerts

Query parameters

limitinteger nullable
page_sizeinteger nullable
offsetinteger nullable
pageinteger nullable
cursorstring nullable
next_cursorstring nullable
afterstring nullable
include_totalboolean

Request body

searchstring nullable

Search term for wildcard search across alert_id, name, description

case_sensitiveboolean

If True, filters and search will be case-sensitive

Example request

{
  "filters": {
    "AND": [
      {
        "field": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "field": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "field": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "field": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOT": [
      {
        "field": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "field": "location",
        "operator": "eq",
        "value": "remote"
      }
    ],
    "case_sensitive": true
  },
  "sort": {
    "field": "created_at"
  }
}

Response

Successful Response

total_countinteger required

Total number of alerts matching query

Example response

{
  "results": [
    {
      "alert_id": "alt_safety_001",
      "description": "Alerts when new videos match known safety incidents",
      "enabled": true,
      "name": "Safety Incident Detector",
      "notification_config": {
        "channels": [
          {
            "channel_id": "wh_safety_team",
            "channel_type": "webhook"
          }
        ],
        "include_matches": true,
        "include_scores": true
      },
      "retriever_id": "ret_safety_search"
    }
  ]
}