Skip to content

List alert channels in enterprise
Stable

Request

⚠️ Android only.

Returns a paginated list of all alert channels configured in the enterprise. Alert channels define the destinations where alert notifications are sent when alarm rules are triggered — currently supporting email as the delivery type. Use this endpoint to discover channel IDs for associating with alarm rules, or to audit existing notification destinations.

Common use cases

Retrieving channel IDs to associate with new or existing alarm rules

Auditing notification destinations across the enterprise

Verifying which alarm rules are linked to a given channel before updating or deleting it

Best practices

Check linked_alerts in the response before deleting a channel — removing a channel that is actively linked to alarm rules will affect those rules' notification delivery

Use the name filter to quickly locate a specific channel without paginating through all results

Note that id is an integer, not a UUID — use it as-is in subsequent calls to GET, PUT, PATCH, or DELETE on /alertchannels/{alert_id}

Security
esper_cloud_api_apiKey
Path
enterprise_idstringrequired

A UUID string identifying this enterprise.

Query
namestring

Filter alert channels by name.

limitinteger

Number of results to return per page.

Default:20
offsetinteger

Return results from this index.

Default:0
cURL
curl -i -X GET \
  'https://api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/alertchannels/?name=string&limit=20&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
countintegerrequired
nextstring or null, (url)
previousstring or null, (url)
resultsArray of objects(esper_cloud_api_AlertChannelsV1)required
Response
{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    { … }
  ]
}