Skip to content

Get alert channel
Stable

Request

⚠️ 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

Security
esper_cloud_api_apiKey
Path
enterprise_idstringrequired

A UUID string identifying this enterprise.

alert_idintegerrequired

An integer identifying the alert channel.

cURL
curl -i -X GET \
  'https://api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
idinteger
propertiesobject
namestring
typestring

format of alert. e.g. email

created_onstring, (date-time)
updated_onstring, (date-time)
enterprisestring, (uuid)
linked_alertsArray of strings
Response
{ "id": 0, "properties": { "to_address": "user@example.com" }, "name": "string", "type": "string", "created_on": "2019-08-24T14:15:22Z", "updated_on": "2019-08-24T14:15:22Z", "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9", "linked_alerts": [ "string" ] }