Alarms

Alarms fire when a monitored item appears in a breach or other source. Read them with whichever scope matches your context: CRM for any account you administer, app token for the logged-in user.

CRM — alarms for a specific account

GET /api/v1/account/{account_id}/alarms
GET /api/v1/account/{account_id}/alarms/statistic
GET /api/v1/account/{account_id}/alarms/{alarmId}

Close an alarm and fetch CoachMe guidance:

GET /api/v1/account/{account_id}/alarms/{alarmId}/close
GET /api/v1/account/{account_id}/alarms/{alarmId}/coachme

Closing uses GET today

Closing an alarm mutates state (status -> CLOSED) but is currently exposed as a GET. Pin to the spec as-is, and avoid triggering it from link prefetchers or crawlers. CoachMe is a read, so GET is correct there. See Deprecations.

App — alarms for the logged-in user

GET /api/v1/alarms
GET /api/v2/alarms
GET /api/v1/alarms/{alarmId}
GET /api/v1/alarms/{alarmId}/close
GET /api/v1/alarms/{alarmId}/coachme
POST /api/v1/alarms/leak/coachme

CRM-wide alarm dashboards

For back-office views across accounts (CRM token):

GET /api/v1/alarms-list
GET /api/v1/alarms
GET /api/v1/alarms/statistic
GET /api/v1/alarms/email-list
GET /api/v1/alarms/phone-list
GET /api/v1/alarms/credit-card-list
GET /api/v1/alarms/company-list
GET /api/v1/alarms/accounts/by-period
GET /api/v2/alarms/company/{companyId}

Related

• Watchlist enrolment — the items that generate alarms
• Integration flows overview