Skip to main content
POST
List war rooms

Restrictions

Usage

  • War rooms whose IM integration is disabled or deleted are still returned, with integration_unavailable set to true.
  • Use chat_id and integration_id with POST /incident/war-room/detail to read the group’s current name and join link.

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

Parameters for listing war rooms linked to an incident.

incident_id
string
required

Incident ID (MongoDB ObjectID).

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

Optional filter: only return war rooms for this IM integration.

for_create
boolean

When true, return only exists instead of items: whether the incident has any war room, on any integration and including ones whose integration is unavailable. integration_id 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

List of war rooms associated with the incident.