> ## Documentation Index > Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt > Use this file to discover all available pages before exploring further. # List alerts by IDs > Return the details of multiple alerts by their IDs in a single request. ## Restrictions | Aspect | Value | | ----------- | ------------------------------------------------------------- | | Rate limits | **1,000 requests/minute**; **50 requests/second** per account | | Permissions | **Channels Read** (`on-call`) | ## Usage * All provided `alert_ids` must belong to the caller's account; any invalid ID causes the entire request to fail. ## OpenAPI ````yaml /api-reference/on-call.openapi.en.json post /alert/list-by-ids openapi: 3.1.0 info: title: Flashduty Open API description: >- Public HTTP API for the Flashduty incident management platform — incidents, notification templates, channels, schedules, monitors, RUM, and platform administration. Every operation is authenticated with an `app_key` query parameter issued from the Flashduty console under Account → APP Keys. Responses follow a uniform envelope: `{ request_id, data }` on success, `{ request_id, error }` on failure. version: 1.0.0 servers: - url: https://api.flashcat.cloud description: Flashduty Open API security: - AppKeyAuth: [] tags: - name: On-call/Incidents description: '' - name: On-call/Channels description: '' - name: On-call/Alerts description: >- Search, inspect, and act on alerts. Manage card views and alert processing pipelines. - name: On-call/Integrations description: '' - name: On-call/IM integrations description: IM integration queries, such as which integrations have war room enabled. - name: On-call/Schedules description: '' - name: On-call/Calendars description: '' - name: On-call/Notification templates description: '' - name: On-call/Alert enrichment description: Custom fields, enrichment rules, and data mapping (schema, data, API). - name: On-call/Analytics description: '' - name: On-call/Status pages description: '' - name: On-call/Changes description: '' paths: /alert/list-by-ids: post: tags: - On-call/Alerts summary: List alerts by IDs description: Return the details of multiple alerts by their IDs in a single request. operationId: alert-read-list-by-ids requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AlertListByIDsRequest' example: alert_ids: - 663a1b2c3d4e5f6789abcdef responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/AlertListResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: total: 1 has_next_page: false items: - alert_id: 663a1b2c3d4e5f6789abcdef title: CPU usage > 90% '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: AlertListByIDsRequest: type: object required: - alert_ids properties: alert_ids: type: array items: type: string description: List of alert IDs (ObjectID hex strings). SuccessEnvelope: type: object description: >- 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`. properties: request_id: type: string description: >- Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues. example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: description: Endpoint-specific payload. See each operation's 200 response schema. required: - request_id - data AlertListResponse: type: object description: Paginated list of alerts. properties: total: type: integer format: int64 description: Total matching alerts. has_next_page: type: boolean description: True if more pages are available. search_after_ctx: type: string description: Cursor for the next page. items: type: array items: $ref: '#/components/schemas/AlertItem' AlertItem: type: object description: A single alert with full detail. properties: alert_id: type: string description: Unique alert ID (ObjectID hex string). integration_id: type: integer format: int64 description: ID of the integration that produced this alert. data_source_id: type: integer format: int64 description: >- Deprecated. Use `integration_id` instead. Deprecated: use `integration_id` instead. deprecated: true channel_id: type: integer format: int64 description: ID of the channel the alert belongs to. account_id: type: integer format: int64 description: Account ID. title: type: string description: Alert title. title_rule: type: string description: >- Title template used to derive `title` from the event labels (e.g. `$service::$cluster`). description: type: string description: Alert description. alert_severity: type: string enum: - Critical - Warning - Info - Ok description: Current severity. alert_status: type: string enum: - Critical - Warning - Info - Ok description: Current status. alert_key: type: string description: Deduplication key. start_time: type: integer format: int64 description: First-seen time, Unix epoch seconds. last_time: type: integer format: int64 description: Last-event time, Unix epoch seconds. end_time: type: integer format: int64 description: Resolution time, Unix epoch seconds. 0 if still active. labels: type: object additionalProperties: type: string description: Label key-value pairs. ever_muted: type: boolean description: True if this alert has ever been silenced. created_at: type: integer format: int64 description: Creation timestamp, Unix epoch seconds. updated_at: type: integer format: int64 description: Last update timestamp, Unix epoch seconds. integration_name: type: string description: Display name of the integration. integration_type: type: string description: Type/plugin key of the integration. integration_ref_id: type: string description: External reference ID of the integration. channel_name: type: string description: Display name of the channel. channel_status: type: string description: Status of the channel (e.g. `enabled`, `disabled`). responder_name: type: string description: >- Display name of the current responder (from the associated incident). responder_email: type: string description: Email of the current responder (from the associated incident). event_cnt: type: integer format: int64 description: Total number of raw events received by this alert. incident: $ref: '#/components/schemas/IncidentShort' description: Associated incident, if any. events: type: array items: $ref: '#/components/schemas/AlertEventItem' description: >- Recent raw events attached to this alert. Populated only by some endpoints. images: type: array items: $ref: '#/components/schemas/AlertImage' description: Images attached to the alert. data_source_name: type: string description: Deprecated. Use `integration_name` instead. data_source_type: type: string description: Deprecated. Use `integration_type` instead. data_source_ref_id: type: string description: Deprecated. Use `integration_ref_id` instead. ErrorResponse: type: object description: Response envelope for errors. `error` is required; `data` is absent. properties: request_id: type: string example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: $ref: '#/components/schemas/DutyError' required: - request_id - error IncidentShort: type: object description: Brief incident reference embedded in an alert. properties: incident_id: type: string description: Incident ID (ObjectID hex string). title: type: string description: Incident title. progress: type: string description: Incident progress — one of `Triggered`, `Processing`, `Closed`. AlertEventItem: type: object description: A raw alert event. properties: event_id: type: string pattern: ^[0-9a-fA-F]{24}$ description: Event ID (MongoDB ObjectID). alert_id: type: string pattern: ^[0-9a-fA-F]{24}$ description: Parent alert ID (MongoDB ObjectID). account_id: type: integer format: int64 description: Account ID. channel_id: type: integer format: int64 description: Channel ID the event is routed to. integration_id: type: integer format: int64 description: Integration that produced this event. integration_type: type: string description: Type/plugin key of the integration that produced this event. data_source_id: type: integer format: int64 description: Deprecated. Use `integration_id` instead. title: type: string description: Event title. title_rule: type: string description: Title template used to derive `title` from labels. description: type: string description: Event description. alert_key: type: string description: Deduplication key used to merge events into an alert. event_severity: type: string enum: - Critical - Warning - Info - Ok description: Severity of this event. event_status: type: string enum: - Critical - Warning - Info - Ok description: Status of this event. event_time: type: integer format: int64 description: Event timestamp, Unix epoch seconds. labels: type: object additionalProperties: type: string description: Label key-value pairs. images: type: array items: $ref: '#/components/schemas/AlertImage' description: Images attached to the event. created_at: type: integer format: int64 description: Record creation time, Unix epoch seconds. updated_at: type: integer format: int64 description: Record update time, Unix epoch seconds. deleted_at: type: integer format: int64 description: Soft-delete timestamp (seconds). Zero if not deleted. AlertImage: type: object description: An image attachment on an alert or event. required: - src properties: href: type: string description: Optional link URL when the image is clicked. src: type: string description: >- Image source URL or internal image reference (starts with `img_` or `http`). alt: type: string description: Alt text. DutyError: type: object description: >- Error payload inside the response envelope. Present only on non-2xx responses. properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string description: >- Human-readable error message, localized by the caller's Accept-Language. May contain field names, IDs, or other context from the failing request. example: The specified parameter template_id is not valid. required: - code - message ErrorCode: type: string description: >- Flashduty error code enum. Every failed API response sets `error.code` to one of these stable wire strings. HTTP status is informational — the authoritative signal is the enum value. | Code | HTTP | Meaning | |---|---|---| | `OK` | 200 | Reserved — not returned on real errors. | | `InvalidParameter` | 400 | A required parameter is missing or failed validation. | | `BadRequest` | 400 | Generic 400 used when no more specific code fits. | | `InvalidContentType` | 400 | The `Content-Type` header is not `application/json`. | | `ResourceNotFound` | 400 | The referenced resource does not exist. Note: returned as HTTP 400, not 404 (historical choice). | | `NoLicense` | 400 | The feature is license-gated and no active license was found. | | `ReferenceExist` | 400 | Deletion blocked — other entities still reference this resource. | | `Unauthorized` | 401 | `app_key` is missing, invalid, or expired. | | `BalanceNotEnough` | 402 | Billing-gated operation with insufficient account balance. | | `AccessDenied` | 403 | Authenticated but lacking the permission required for this operation. | | `RouteNotFound` | 404 | The request URL path is not a known route. | | `MethodNotAllowed` | 405 | The HTTP method is not allowed on this otherwise-known path. | | `UndonedOrderExist` | 409 | An outstanding billing order blocks this new one. Wait and retry. | | `RequestLocked` | 423 | Operation temporarily locked due to repeated failures. | | `EntityTooLarge` | 413 | Request body exceeds the configured max size. | | `RequestTooFrequently` | 429 | Rate limit hit — API-global, per-account, or per-integration. | | `RequestVerifyRequired` | 428 | Second-factor verification required but not supplied. | | `DangerousOperation` | 428 | High-risk operation requires MFA verification. | | `InternalError` | 500 | Unhandled server-side error. Include `request_id` in the bug report. | | `ServiceUnavailable` | 503 | A backend dependency is unavailable. Try again later. | enum: - OK - InvalidParameter - BadRequest - InvalidContentType - ResourceNotFound - NoLicense - ReferenceExist - Unauthorized - BalanceNotEnough - AccessDenied - RouteNotFound - MethodNotAllowed - UndonedOrderExist - RequestLocked - EntityTooLarge - RequestTooFrequently - RequestVerifyRequired - DangerousOperation - InternalError - ServiceUnavailable x-enumDescriptions: OK: Reserved — not returned on real errors. InvalidParameter: A required parameter is missing or failed validation. BadRequest: Generic 400 used when no more specific code fits. InvalidContentType: The `Content-Type` header is not `application/json`. ResourceNotFound: >- The referenced resource does not exist. Note: returned as HTTP 400, not 404 (historical choice). NoLicense: The feature is license-gated and no active license was found. ReferenceExist: Deletion blocked — other entities still reference this resource. Unauthorized: '`app_key` is missing, invalid, or expired.' BalanceNotEnough: Billing-gated operation with insufficient account balance. AccessDenied: Authenticated but lacking the permission required for this operation. RouteNotFound: The request URL path is not a known route. MethodNotAllowed: The HTTP method is not allowed on this otherwise-known path. UndonedOrderExist: An outstanding billing order blocks this new one. Wait and retry. RequestLocked: Operation temporarily locked due to repeated failures. EntityTooLarge: Request body exceeds the configured max size. RequestTooFrequently: Rate limit hit — API-global, per-account, or per-integration. RequestVerifyRequired: Second-factor verification required but not supplied. DangerousOperation: High-risk operation requires MFA verification. InternalError: Unhandled server-side error. Include `request_id` in the bug report. ServiceUnavailable: A backend dependency is unavailable. Try again later. example: InvalidParameter responses: BadRequest: description: Invalid request — usually a missing or malformed parameter. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingParameter: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InvalidParameter message: The specified parameter is not valid. Unauthorized: description: Missing or invalid app_key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingAppKey: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: Unauthorized message: You are unauthorized. TooManyRequests: description: >- Rate limit hit. Either the global API limit, a per-account limit, or a per-integration limit. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimited: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: RequestTooFrequently message: Request too frequently. ServerError: description: Unexpected server-side error. Include the request_id when reporting. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internal: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InternalError message: >- We encountered an internal error, and it has been reported. Please try again later. securitySchemes: AppKeyAuth: type: apiKey in: query name: app_key description: >- 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. ````