Alerts
List alert statuses
List all custom alert statuses for your organization and the allowed colour codes.
GET
/
cloud
/
alerts
/
statuses
List alert statuses
curl --request GET \
--url http://localhost:5001/cloud/alerts/statuses \
--header 'X-blnk-key: <api-key>'import requests
url = "http://localhost:5001/cloud/alerts/statuses"
headers = {"X-blnk-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-blnk-key': '<api-key>'}};
fetch('http://localhost:5001/cloud/alerts/statuses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "5001",
CURLOPT_URL => "http://localhost:5001/cloud/alerts/statuses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-blnk-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:5001/cloud/alerts/statuses"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-blnk-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:5001/cloud/alerts/statuses")
.header("X-blnk-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5001/cloud/alerts/statuses")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["X-blnk-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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.
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"
]
}
array
required
Array of custom status objects for the organization.
array
required
List of hex colour codes allowed when creating or updating a status.
Show Status object properties
Show Status object properties
string
required
Organization ID that owns the status.
string
required
Unique key for the status (e.g. PENDING_REVIEW). Used when setting an alert’s status and in update/delete URLs.
string
required
Display name for the status.
string
required
Hex colour code for the status (one of allowed_colours).
timestamp
required
ISO 8601 timestamp when the status was created.
timestamp
required
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.Was this page helpful?
⌘I
List alert statuses
curl --request GET \
--url http://localhost:5001/cloud/alerts/statuses \
--header 'X-blnk-key: <api-key>'import requests
url = "http://localhost:5001/cloud/alerts/statuses"
headers = {"X-blnk-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-blnk-key': '<api-key>'}};
fetch('http://localhost:5001/cloud/alerts/statuses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "5001",
CURLOPT_URL => "http://localhost:5001/cloud/alerts/statuses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-blnk-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:5001/cloud/alerts/statuses"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-blnk-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:5001/cloud/alerts/statuses")
.header("X-blnk-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5001/cloud/alerts/statuses")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["X-blnk-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
]
}