Skip to main content
GET
List Deliverability Incidents
Alert types turned off in your team’s Notifications settings (Deliverability > Alerts) are never returned. Resolved incidents are kept 90 days.
This endpoint is in closed beta. It answers 403 with the code BETA_NOT_ENABLED unless the deliverability incidents beta is enabled for your team.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

type
enum<string>

Only incidents of this type.

Available options:
dnsIssue,
mailboxDisconnected,
lemwarmDisconnected,
lemwarmPaused
state
enum<string>

active: the issue is still there. resolved: it cleared. Omit for both.

Available options:
active,
resolved
userId
string

Only incidents on mailboxes owned by this teammate.

since
string

Only incidents detected at or after this date or instant (ISO 8601; a date-time needs its offset).

until
string

Only incidents detected at or before this date or instant (ISO 8601; a date-time needs its offset).

limit
integer
default:20

Maximum number of incidents to return.

Required range: 1 <= x <= 100
skip
integer
default:0

Number of incidents to skip, for pagination.

Required range: x >= 0

Response

Success

data
object