Retrieves a single alert by its identifier for a specific account
Use this endpoint to get the full details of one specific alert when you know both the account and alert IDs.
To list all alerts on an account, use GET /account/{accountId}/alert instead.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| accountId | The unique numeric identifier of the account the alert belongs to | integer (int32) | Required |
| alertId | The unique numeric identifier of the specific alert to retrieve | integer (int32) | Required |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
AccountAlertResponse
| Property | Description | Type |
|---|---|---|
| alertId | The unique identifier for this alert | integer (int32) |
| allowBillProcessing | When true, bills can still be processed despite this alert. When false, the alert blocks bill processing. | boolean |
| beginDate | The date the alert becomes active and visible | string (date-time) |
| endDate | The date the alert expires and is no longer displayed | string (date-time) |
| message | The alert message text displayed to users | string |
Example Response
{ "alertId": 1, "allowBillProcessing": false, "beginDate": "2026-06-29", "endDate": "2026-06-29", "message": "string"
}
404
Not Found
The requested resource was not found. Verify the ID or path is correct.