Skip to main content
GET
/
cloud
/
alerts
/
statuses
List alert statuses
curl --request GET \
  --url http://localhost:5001/cloud/alerts/statuses \
  --header 'X-blnk-key: <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"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
Response structure

{
  "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"
  ]
}
​
data
array
required
Array of custom status objects for the organization.
​
allowed_colours
array
required
List of hex colour codes allowed when creating or updating a status.

​
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.