Get Alerts

Authorization

x-maxim-api-key<token>

API key for authentication

In: header

Query Parameters

idstring

Unique identifier for the alert

workspaceIdRequiredstring

Unique identifier for the workspace

Minimum length: 1

entityIdRequiredstring

ID of the entity associated with the alert

limitnumber

Maximum number of records to return (max: 100)

Default: 20Maximum: 100

cursorstring

Cursor for pagination

curl -X GET "https://api.getmaxim.ai/v1/alerts?id=%3Cstring%3E&workspaceId=%3Cstring%3E&entityId=%3Cstring%3E&limit=20&cursor=%3Cstring%3E" \
  -H "x-maxim-api-key: <token>"

Alerts retrieved successfully

{
  "data": [
    {
      "id": "string",
      "workspaceId": "string",
      "entityId": "string",
      "type": "string",
      "enabled": true,
      "config": {
        "metric": "string",
        "minimumThreshold": 1,
        "duration": 0,
        "operator": "string",
        "value": "string",
        "renotifyTTL": -1
      },
      "createdAt": "string",
      "updatedAt": "string",
      "notificationChannels": [
        {
          "notificationChannel": {
            "id": "string",
            "type": "SLACK",
            "name": "string",
            "config": {
              "property1": null,
              "property2": null
            }
          }
        }
      ]
    }
  ],
  "pagination": {
    "cursor": "string",
    "hasMore": true
  }
}

Authorization

Query Parameters

Response

TypeScript