Get Alert Configuration

Returns one alert configuration the company has set up: which alert template it uses, when it runs, who receives it, and any custom subject, message, or list-value filters. The response is a single JSON object with no wrapper.

Use this when the configuration's id is already known, either from List Alert Configurations (list-alert-configurations) or from the body Create Alert Configuration (create-alert-configuration) and Replace Alert Configuration (replace-alert-configuration) return. To enumerate or search a company's configured alerts, use list-alert-configurations instead. For the catalog of alert types that can be configured, rather than what this company has configured, use List Alert Templates (list-alert-templates). The bambooAlertId on the returned object identifies the underlying template, not this configuration, so the two identifiers are not interchangeable.

Access is all-or-nothing rather than per-record. An authenticated caller without view access to the company's Email Alerts settings receives 403 rather than a partially redacted object. Only configurations belonging to the authenticated company are reachable, and an id from any other company is indistinguishable from one that never existed.

OAuth Scopes: alerts

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Identifier of the alert configuration to return, as emitted in the id field of List Alert Configurations (list-alert-configurations). This is the configuration's own identifier, not the bambooAlertId of the alert template it is based on. No wildcard or 0 sentinel is supported; enumerate configurations with list-alert-configurations instead.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized.

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json