List alert statuses

GET

alerts

statuses

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"
  ]
}

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.

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.

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

Response

{
  "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"
  ]
}

array

Array of custom status objects for the organization.

array

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

string

Organization ID that owns the status.

string

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

string

Display name for the status.

string

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

timestamp

ISO 8601 timestamp when the status was created.

timestamp

ISO 8601 timestamp when the status was last updated.

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.

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"
  ]
}

Start Here

Deployments

Proxy & data

Data lake

AI integrations

Audit

Alerts

Billing

Authorization

Response

Need help?

​Authorization

​Response

​Need help?

Authorization

Response

Need help?