AIXBT Docs
API v3Reference

Get an alert subscription

GET
/v3/alerts/{id}

Owner-scoped read; another owner's id behaves as not_found.

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

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v3/alerts/string"
{
  "data": {
    "id": "66a10a2b1c9d440000d1e2f3",
    "status": "active",
    "trigger": "intelligence.material",
    "selector": {
      "followedProjects": true
    },
    "cadence": "hourly",
    "destinationIds": [
      "66a10a2b1c9d440000aa0001"
    ],
    "createdAt": "2026-08-01T10:00:00Z",
    "updatedAt": "2026-08-05T04:00:00Z"
  },
  "meta": {}
}

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

{
  "code": "not_found",
  "message": "No Project matches that locator.",
  "details": {
    "subject": {
      "type": "project",
      "locator": "examplechain"
    }
  }
}

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