GET
/
v1
/
alerts
curl --request GET \
  --url https://api.getmaxim.ai/v1/alerts \
  --header 'x-maxim-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "workspaceId": "<string>",
      "entityId": "<string>",
      "type": "<string>",
      "enabled": true,
      "config": {
        "metric": "<string>",
        "minimumThreshold": 2,
        "duration": 123,
        "operator": "<string>",
        "value": "<string>",
        "renotifyTTL": -1
      },
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "notificationChannels": [
        {
          "notificationChannel": {
            "id": "<string>",
            "type": "SLACK",
            "name": "<string>",
            "config": {}
          }
        }
      ]
    }
  ],
  "pagination": {
    "cursor": "<string>",
    "hasMore": true
  }
}

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Query Parameters

id
string

Unique identifier for the alert

workspaceId
string
required

Unique identifier for the workspace

Minimum length: 1
entityId
string
required

ID of the entity associated with the alert

limit
number | null
default:20

Maximum number of records to return (max: 100)

Required range: x <= 100
cursor
string | null

Cursor for pagination

Response

200
application/json

Alerts retrieved successfully

The response is of type object.