v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
esper_cloud_api_Alerts

Get alert channel

⚠️ Android only.

Returns the details of a single alert channel identified by its alert_id. Use this endpoint to retrieve the current configuration of a specific channel — including its delivery type, destination address, and any alarm rules it is linked to — before updating or deleting it.

Note that alert_id is an integer, not a UUID. Use GET /v1/enterprise/{enterprise_id}/alertchannels/ to look up an alert_id if it is not already known.

Response fields of note

id — Integer identifier for the channel

name — Display name for the channel

type — Delivery format (e.g., email)

properties.to_address — The email address notifications are sent to

linked_alerts — Array of alarm rules currently using this channel

created_on / updated_on — Timestamps for auditing purposes

Common use cases

Retrieving a channel's current configuration before issuing an update

Checking linked_alerts to understand which alarm rules depend on this channel before modifying or deleting it

Confirming a channel was created correctly after a POST /alertchannels/ call

Best practices

Always retrieve the current state of a channel before updating it to avoid overwriting fields unintentionally

Review linked_alerts before deletion — channels actively linked to alarm rules should be unlinked or replaced first to avoid disrupting alert delivery

If the alert_id is not known, use GET /alertchannels/ with the name filter to locate it

get/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}

Path parameters

enterprise_idstring required

A UUID string identifying this enterprise.

alert_idinteger required

An integer identifying the alert channel.

Response

successful operation

idinteger
namestring
typestring

format of alert. e.g. email

created_onstring date-time
updated_onstring date-time
enterprisestring uuid
linked_alertsstring[]