Skip to main content
POST
List incidents

Restrictions

Usage

  • Only incidents in channels the caller can access are returned.
  • start_time and end_time filter on incident start time and may span at most 31 days. A start_time earlier than the account’s data retention period is moved up to the retention boundary; an end_time before that boundary fails with InvalidParameter.
  • Results are sorted by start_time, newest first unless asc is true.
  • Paginate with p and limit, or pass the previous response’s search_after_ctx, in which case p is ignored.
  • total is capped at 1,000. has_next_page does not depend on total: with p/limit paging and in cursor mode alike it reflects whether more rows really exist, also past 1,000 incidents. Every non-empty page also returns search_after_ctx for cursor paging.
  • Without progress, incidents in every progress state are returned.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Filters for the incident list query. start_time and end_time are required; the window must not exceed 31 days.

start_time
integer<int64>
required

Start of the time window (Unix timestamp in seconds). The window with end_time may span at most 31 days and filters by incident start time.

end_time
integer<int64>
required

Window end, Unix seconds. Must be greater than start_time and within 31 days.

asc
boolean

Ascending order when true.

is_snoozed
boolean

When true, include only snoozed incidents.

is_my_team
boolean

When true, restrict to incidents in channels owned by the user's teams.

is_my_channel
boolean

When true, restrict to incidents in channels the user personally owns.

ever_muted
boolean

When true, include only incidents that were ever silenced.

is_rare
boolean

When true, include only outlier (rare) incidents.

has_unfinished_work_item
boolean

When true, include only incidents that still have an action item or follow-up that is neither done nor cancelled. false applies no filter.

progress
string

Comma-separated progress states to match, for example Triggered,Processing. Values: Triggered not yet acknowledged; Processing acknowledged and being handled; Closed resolved. Omit to match every state.

query
string

Full-text search query.

incident_severity
string

Comma-separated severities to match, for example Critical,Warning. Values: Critical most severe, Warning, Info least severe.

channel_ids
integer<int64>[]

Channel IDs to filter by. Use 0 for standalone (global) incidents.

team_ids
integer<int64>[]

Team IDs; resolved to channels via channel ownership.

responder_ids
integer<int64>[]

Filter by responder member IDs; obtain member IDs from POST /member/list.

acker_ids
integer<int64>[]

Filter by acker member IDs; obtain member IDs from POST /member/list.

creator_ids
integer<int64>[]

Creator member IDs. Use 0 for automatically created incidents.

closer_ids
integer<int64>[]

Closer member IDs. Use 0 for automatically closed incidents.

incident_ids
string[]

Restrict to the given incident IDs. At most 100 items per request; split larger sets into several calls.

Maximum array length: 100
nums
string[]

Filter by incident short numbers (the numbers shown before incident titles in the console). At most 100 items per request; split larger sets into several calls.

Maximum array length: 100
p
integer<int64>

Page number starting at 1.

Required range: x >= 0
limit
integer<int64>
default:20

Page size, at most 100. With page-number paging, p × limit may not exceed 10,000.

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

Cursor from the previous response's search_after_ctx; when set, p is ignored.

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

Paginated list of incidents.