Alerts

List alert statuses

List all custom alert statuses for your organization and the allowed colour codes.

GET/alerts/statuses

List all custom alert statuses for your organization and the allowed colour codes. Use this to build status pickers and show name/colour for each status.

Enterprise authentication

Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.

Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with Enterprise OAuth.

This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.

X-blnk-keystringrequiredheader

Enterprise API key, or an OAuth access token.

Response

dataarray

Array of custom status objects for the organization.

allowed_coloursarray

List of hex colour codes allowed when creating or updating a status.

organization_idstring

Organization ID that owns the status.

keystring

Unique key for the status (e.g. PENDING_REVIEW). Used when setting an alert’s status and in update/delete URLs.

namestring

Display name for the status.

colourstring

Hex colour code for the status (one of allowed_colours).

created_attimestamp

ISO 8601 timestamp when the status was created.

updated_attimestamp

ISO 8601 timestamp when the status was last updated.

curl -X GET 'https://api.cloud.blnkfinance.com/alerts/statuses' \
  -H 'X-blnk-key: CLOUD_API_KEY'

{
  "data": [
    {
      "organization_id": "org_01ABC123",
      "key": "PENDING_REVIEW",
      "name": "Pending Review",
      "colour": "#3B82F6",
      "created_at": "2025-01-29T14:00:00Z",
      "updated_at": "2025-01-29T14:00:00Z"
    }
  ],
  "allowed_colours": [
    "#3B82F6", "#10B981", "#F59E0B", "#EF4444", "#8B5CF6",
    "#EC4899", "#06B6D4", "#84CC16", "#F97316", "#6366F1",
    "#14B8A6", "#A855F7", "#E11D48", "#64748B", "#0EA5E9"
  ]
}