Platform API ReferenceNotification Channels

List Alert Notification Channels

List Alert Notification Channels.

Path parameters

organizationIdstringRequired
The ID of the Organization to which the Notification Channels belong.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

notificationChannelIdslist of stringsOptional
A list of IDs of specific Notification Channels to list. The API will list information only for Notification Channels which have been specified in this list.
deploymentIdslist of stringsOptional
A list of Deployment IDs to filter by, not allowed if Workspace IDs are provided. Returns Notification Channels scoped to these Deployments, plus any shared Organization or Workspace Notification Channels accessible to them.
workspaceIdslist of stringsOptional
A list of Workspace IDs to filter by, not allowed if Deployment IDs are provided. Returns Notification Channels scoped to these Workspaces, plus any shared Organization or Deployment Notification Channels accessible to them.
channelTypeslist of enumsOptional
A list of Notification Channel types to filter by.
Allowed values:
entityTypeenumOptional
The type of entity the Notification Channels belong to.
Allowed values:
offsetintegerOptional>=0Defaults to 0
The number of results to skip before returning values.
limitintegerOptional>=0Defaults to 20
The maximum number of results to return.
sortslist of enumsOptional

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Response

OK
limitinteger
The maximum number of notification channels to return.
notificationChannelslist of objects
The notification channels.
offsetinteger
The offset of the first notification channel in the list.
totalCountinteger
The total number of notification channels.

Errors