AIXBT Docs
API v3Reference

List my alert subscriptions

GET
/v3/alerts

Alert subscriptions owned by the calling credential. One owner may hold at most 50 subscriptions, paused rows included. Lists the API-manageable kinds (intelligence.material, rank.entered); preset subscriptions managed in product Settings do not appear here.

Authorization

ApiKeyAuth
x-api-key<token>

API key. The Authorization header is accepted as an equivalent carrier. Responses echo the credential class in X-API-Key-Type.

In: header

Query Parameters

cursor?string

Opaque cursor from meta.nextCursor.

limit?integer
Default50
Range1 <= value <= 50

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v3/alerts"

{
  "data": [
    {
      "id": "66a10a2b1c9d440000d1e2f3",
      "status": "active",
      "trigger": "intelligence.material",
      "selector": {
        "followedProjects": true,
        "qualifiers": {
          "grades": [
            "polished",
            "flawless"
          ],
          "categories": [
            "product-launch"
          ]
        }
      },
      "cadence": "hourly",
      "destinationIds": [
        "66a10a2b1c9d440000aa0001"
      ],
      "createdAt": "2026-08-01T10:00:00Z",
      "updatedAt": "2026-08-05T04:00:00Z"
    }
  ],
  "meta": {
    "nextCursor": null
  }
}

{
  "code": "credential_required",
  "message": "Provide an API key via the x-api-key header."
}

{
  "code": "rate_limited",
  "message": "Minute limit reached.",
  "details": {
    "limit": 30,
    "window": "minute"
  }
}
{
  "code": "internal_error",
  "message": "Unexpected error."
}

List Clusters GET

Audience/source archetypes used as an analysis dimension across Topics and Intel.

Create an alert subscription POST

Creates an owner-scoped subscription: selector + one trigger + delivery cadence + explicit destination ids. Destinations are provisioned in product Settings and referenced here by id. Chat cadence defaults to `hourly`; `instant` is subject to a per-day platform safety ceiling. Webhook destinations receive every admitted event regardless of cadence. The 50-subscription owner cap and selector list bounds (20 values per list) are enforced. An account holds at most one `rank.entered` subscription; creating a second while one exists fails with `invalid_request`.