On-Call API › Alerts
List alerts
Lists the organization's alerts, newest first unless sort says otherwise.
The list is paged: limit (default 50) and offset, with the number of
matching alerts in meta.total. Every filter is optional and they combine.
team_id narrows the list, it never hides anything you could otherwise see:
a team id returns that team's alerts together with the organization-wide ones
(alerts with no team), and none returns only the organization-wide ones.
Permission (API-key scope): oncall:alert:read.
Authorization
bearerAuth(oncall:alert:read)apiKeyHeader(oncall:alert:read)
Parameters
Query parameters
statusstringtriggered,acknowledged,resolved,suppressed, oropenfor triggered and acknowledged together.severityAlertSeverityOne severity.sourcestringThe kind of integration or origin, for exampleprometheusormanual.qstringFree-text search over the title, source and label values (case-insensitive, partial match).assigneestringA user id,mefor the caller, orunassigned.escalation_policy_idstringOnly alerts routed to this escalation policy.integration_idstringOnly alerts opened by this integration.team_idstringA team id (that team's alerts plus organization-wide ones) ornone(organization-wide alerts only).created_fromstringEarliest creation time, inclusive: RFC 3339, or a date (YYYY-MM-DD, start of the UTC day). An unreadable value is ignored.created_tostringLatest creation time, inclusive: RFC 3339, or a date (YYYY-MM-DD, the whole UTC day). An unreadable value is ignored.sortstringColumn to sort by.dirstringSort direction. Empty values sort last either way.limitintegerPage size. 0 or omitted means 50.offsetintegerHow many items to skip.
Responses
200
A page of alerts.
dataarray of Alert requiredShow Alert properties
idstring requiredorg_idstring requiredteam_idstringOwning team; empty for an organization-wide alert.escalation_policy_idstringEmpty when no policy pages for it.incident_idstringintegration_idstringThe integration that opened it; empty for alerts raised by hand or by another EvoHub product.fingerprintstringDeduplication key: while an alert with it is open, the same fingerprint retriggers it instead of opening another.titlestring requireddescriptionstringseverityAlertSeverity requiredstatusAlertStatus requiredsourcestring requiredWhere it came from: an integration kind such asprometheus,api,webhook, ormanual.labelsobjectannotationsobjectcurrent_escalation_stepintegerThe escalation step reached so far.acknowledged_bystringacknowledged_atstring (date-time)resolved_bystringresolved_atstring (date-time)snoozed_untilstring (date-time)snoozed_bystringassigned_tostringUser id of the assignee; empty when unassigned.notification_countintegerretrigger_countintegerHow many times the same fingerprint arrived again while it was open.created_atstring (date-time) requiredupdated_atstring (date-time) required
successboolean requiredmetaobject requiredtotalintegerAlerts matching the filters, ignoring the page.
400
sort names a column that cannot be sorted on, or dir is not asc or desc (VALIDATION_FAILED).
errorobject requiredcodestring requiredmessagestring requireddetailsarray of object requiredfieldstringmessagestring
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
Example request
curl -X GET 'https://evohub.io/api/v1/alerts' \
-H 'Authorization: Bearer <TOKEN>'