Skip to main content
POST
Get incident timeline

Restrictions

Usage

  • For i_comm entries, detail.comment_type is resolved from the current account-level comment type definition at read time, so it reflects the type’s latest name and color.
  • Only entries recorded on the incident itself are returned; alert-level entries are read through the alert endpoints.
  • Entries are ordered by creation time, newest first unless asc is true. Paginate with p and limit; has_next_page tells whether another page exists, and no total count is returned.
  • For i_notify entries, failed_reason is a localized message describing a delivery failure, filled in at read time.

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 timeline query.

incident_id
string
required

Incident ID (MongoDB ObjectID).

Pattern: ^[0-9a-fA-F]{24}$
p
integer<int64>
default:1

Page number starting at 1.

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

Page size, at most 100.

Required range: 1 <= x <= 100
asc
boolean

Ascending chronological order when true.

types
enum<string>[]

Return only entries of these types; omit to return all types.

Incident timeline entry type. Each value identifies one lifecycle event; the matching detail payload shape is determined by this field. Incident types are prefixed with i_.

Available options:
i_new,
i_assign,
i_a_rspd,
i_notify,
i_storm,
i_snooze,
i_wake,
i_ack,
i_unack,
i_comm,
i_rslv,
i_reopen,
i_merge,
i_r_title,
i_r_desc,
i_r_impact,
i_r_rc,
i_r_rsltn,
i_r_severity,
i_r_field,
i_m_flapping,
i_m_reply,
i_custom,
i_wr_create,
i_wr_delete,
i_auto_refresh,
i_wi_created,
i_wi_updated,
i_wi_assignees,
i_wi_completed,
i_wi_converted,
i_wi_bound,
i_wi_deleted,
i_wi_auto_converted,
a_merge

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

Page of incident timeline entries.