Skip to main content
GET
Retrieve alerts from your workspace. If you don’t include an alert ID in the path, the endpoint returns all alerts.
Prefer /alerts. /anomalies is a legacy alias with the same alerts:read and alerts:write scopes.

Authorization

Blnk Cloud APIs support any one of the following authentication methods. All of them work with your CLOUD_API_KEY or OAUTH_ACCESS_TOKEN. Pass X-blnk-key: CLOUD_API_KEY or X-blnk-key: OAUTH_ACCESS_TOKEN.
string
required
Cloud API key or OAuth access token. Create credentials in API keys or OAuth.

Path

string
Optional. Unique identifier for a specific alert to retrieve. Omit to retrieve all alerts.

Response

string
Unique identifier for the alert.
string
The title of the alert, if provided.
string
The description of the alert.
string
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
The current status of the alert (e.g., “FLAGGED”).
timestamp
ISO 8601 formatted timestamp of when the alert was created.
timestamp
ISO 8601 formatted timestamp of when the alert was last updated.
array
Array of balance IDs affected by this alert.
array
Array of identity IDs affected by this alert.
array
Array of transaction IDs affected by this alert.

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.