Skip to main content
POST
List alerts

Restrictions

Usage

  • Both start_time and end_time are required Unix epoch seconds. Maximum span is 31 days.
  • Use search_after_ctx from the previous response to fetch the next page.
  • Results are filtered by the caller’s channel data-access permissions.
  • Set is_active to true to retrieve only active (firing) alerts; false to retrieve resolved alerts.

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Filter and pagination criteria for alert list queries. Time range is required.

start_time
integer<int64>
required

Start of the search window, Unix epoch seconds.

end_time
integer<int64>
required

End of the search window, Unix epoch seconds. Must be greater than start_time; the span must not exceed 31 days and must lie within the account's data retention period.

p
integer<int64> | null

Page number, starting at 1. Used when search_after_ctx is not provided; p * limit must stay within 10,000 records.

Required range: x >= 0
limit
integer<int64> | null

Page size. Max 100, default 20.

Required range: 0 <= x <= 100
search_after_ctx
string | null

Opaque cursor from the previous response for the next page.

is_active
boolean | null

Filter by lifecycle: true returns only firing alerts (status Critical/Warning/Info), false returns only recovered alerts (status Ok). Omit or pass null to return both.

ever_muted
boolean | null

Filter by whether the alert has ever been silenced.

alert_severity
string

Comma-separated severity filter, e.g. Critical,Warning. Allowed values: Critical, Warning, Info, Ok.

channel_ids
integer<int64>[]

Filter by channel IDs.

integration_ids
integer<int64>[]

Filter by integration IDs.

alert_ids
string[]

Filter to specific alert IDs (ObjectID hex strings). Invalid IDs are ignored; if none are valid, the result is empty.

alert_keys
string[]

Filter by alert deduplication keys.

asc
boolean

Sort ascending by start_time when true; default is descending.

by_updated_at
boolean

When true, the time range filter is applied on updated_at rather than start_time.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
required

Paginated list of alerts.