Alerts
Get alert
Retrieve alerts. Omit the alert ID to fetch all alerts, or include it to retrieve a specific alert.
GET
Retrieve alerts from your workspace. If you don’t include an alert ID in the path, the endpoint returns all alerts.
Request structure
string
Optional. Unique identifier for a specific alert to retrieve. Omit to retrieve all alerts.
Response structure
string
required
Unique identifier for the alert.
string
The title of the alert, if provided.
string
required
The description of the alert.
string
required
The type or category of the alert (e.g., “Balance”, “Transaction”, “Identity”).
string
The name or identifier of the user assigned to handle the alert.
array
Array of user identifiers to whom the alert has been escalated.
string
required
The current status of the alert (e.g., “FLAGGED”).
timestamp
required
ISO 8601 formatted timestamp of when the alert was created.
timestamp
required
ISO 8601 formatted timestamp of when the alert was last updated.
array
required
Array of balance IDs affected by this alert.
array
required
Array of identity IDs affected by this alert.
array
required
Array of transaction IDs affected by this alert.