Skip to main content
GET
/
v1
/
alarms
/
{id}
Get Alarm
curl --request GET \
  --url https://api.bland.ai/v1/alarms/{id} \
  --header 'authorization: <authorization>'
{
  "data": {
    "alarm": {
      "id": "9a6d2ad2-a9c6-4e4a-bde6-4bb6fc22b907",
      "metric_type": "latency",
      "enabled": true,
      "threshold": 0.5,
      "webhook_config": {
        "url": "https://example.com/webhooks/alarms",
        "headers": {
          "Content-Type": "appl***"
        }
      },
      "email_addresses": ["alerts@example.com"],
      "sms_numbers": ["+15555550123"],
      "created_at": "2026-03-12T16:13:02.694Z",
      "updated_at": "2026-03-12T16:34:09.340Z"
    }
  },
  "errors": null
}

​
Headers

​
authorization
string
required
Your API key for authentication.

​
Path Parameters

​
id
string
required
Alarm configuration ID.

​
Response

​
data.alarm
object
Alarm configuration object.
​
data.alarm.id
string
Alarm configuration ID.
​
data.alarm.metric_type
string
Metric this alarm tracks.
​
data.alarm.threshold
number
Trigger threshold for this metric.
​
data.alarm.enabled
boolean
Whether this alarm is enabled.
​
data.alarm.webhook_config
object|null
Webhook settings object. Header values may be masked in API responses.
​
data.alarm.email_addresses
string[]
Email recipients for notifications. Can be an empty array if none are configured.
​
data.alarm.sms_numbers
string[]
SMS recipients for notifications. Can be an empty array if none are configured.
​
data.alarm.created_at
string
ISO creation timestamp.
​
data.alarm.updated_at
string
ISO update timestamp.
{
  "data": {
    "alarm": {
      "id": "9a6d2ad2-a9c6-4e4a-bde6-4bb6fc22b907",
      "metric_type": "latency",
      "enabled": true,
      "threshold": 0.5,
      "webhook_config": {
        "url": "https://example.com/webhooks/alarms",
        "headers": {
          "Content-Type": "appl***"
        }
      },
      "email_addresses": ["alerts@example.com"],
      "sms_numbers": ["+15555550123"],
      "created_at": "2026-03-12T16:13:02.694Z",
      "updated_at": "2026-03-12T16:34:09.340Z"
    }
  },
  "errors": null
}