Skip to content

Get an alert

The alerts.get operation: GET /api/v1/alerts/{id} in the REST API and the alerts_get tool in the MCP server.

GET/api/v1/alerts/{id}

Returns one alert of the organization in the mode of the request: what happened (code, severity, message), where to act on it (link, a console page), how often it was raised while unresolved (occurrences), who acknowledged or resolved it, and how it was delivered (emails sent, Slack channels). An alert your role may not see answers resource_not_found, as if it didn't exist.

At a glance

  • REST: GET /api/v1/alerts/{id}
  • MCP tool: alerts_get
  • Operation ID: alerts.get
  • Scope: Organization
  • Permission: org:read
  • Risk tier: read
  • Dry run: Not supported
  • Idempotency: Not needed (read only)
  • Modes: Test and live
  • Authentication: API key with the org:read scope
  • Since: M7

Request

Path parameters

FieldTypeDescription
idalr_… ID

Query parameters

This operation takes no query parameters.

Response

200 OK with a JSON object:

FieldTypeDescription
idalr_… ID
object"alert"
codestring
severityone of info, high, critical
familyone of 14 values, e.g. registrations, filings, ledger (all in the OpenAPI document)
messagestring
linkstring
entityIdent_… ID or null
brandIdbrd_… ID or null
livemodeboolean
statusone of open, acked, resolved
occurrencesinteger (at least 1)
lastRaisedAtdate-time
acknowledgedAtdate-time or null
acknowledgedBystring or null
resolvedAtdate-time or null
resolvedBystring or null
deliveryobject
delivery.statusone of none, pending, delivered, failed
delivery.attemptsinteger (at least 0)
delivery.lastErrorstring or null
delivery.emailobject
delivery.email.sentinteger (at least 0)
delivery.email.failedinteger (at least 0)
delivery.slackarray of object
delivery.slack[].channelIdstring
delivery.slack[].statusone of sent, failed
delivery.slack[].atdate-time
delivery.slack[].errorstring or null
createdAtdate-time
updatedAtdate-time
versioninteger (at least 1)

Examples

An automatic block

HTTP
GET /api/v1/alerts/alr_01m4ttwd3veh9apbewxheq5xab
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "id": "alr_01m4ttwd3veh9apbewxheq5xab",
  "object": "alert",
  "code": "REG_AUTO_BLOCKED",
  "severity": "critical",
  "family": "registrations",
  "message": "EU_OSS_NON_UNION was blocked for new consumer sales on 2026-11-07: the grace deadline 2026-11-10 is near and no application was submitted.",
  "link": "/console/acme/e/acme-hr/jurisdictions/EU_OSS_NON_UNION",
  "entityId": "ent_01m4ttwd3veh9apbewxheq5xh4",
  "brandId": null,
  "livemode": true,
  "status": "open",
  "occurrences": 1,
  "lastRaisedAt": "2026-10-13T12:00:00.000Z",
  "acknowledgedAt": null,
  "acknowledgedBy": null,
  "resolvedAt": null,
  "resolvedBy": null,
  "delivery": {
    "status": "delivered",
    "attempts": 1,
    "lastError": null,
    "email": {
      "sent": 2,
      "failed": 0
    },
    "slack": [
      {
        "channelId": "sec_01m4ttwd3veh9apbewxheq5xad",
        "status": "sent",
        "at": "2026-10-13T12:00:00.000Z",
        "error": null
      }
    ]
  },
  "createdAt": "2026-10-13T12:00:00.000Z",
  "updatedAt": "2026-10-13T12:00:00.000Z",
  "version": 1
}

Errors

CodeHTTP statusWhenWhat to do
resource_not_found404No alert with this ID that you may see, in this organization and mode.Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.
permission_denied403You can't read this organization's inbox.Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: validation_failed, api_version_unsupported, authentication_required, api_key_invalid, dry_run_not_supported, rate_limited, internal_error.