List Alert Templates

Returns the catalog of alert templates that company alert configurations are built from. These are the built-in alert types BambooHR supports (for example New Hire, Birthdays, Time Off Approved), each paired with the settings group it is filed under.

The response is an object with a single alerts array, ordered by groupName and then name. The alert-configuration endpoints represent the same identifier as bambooAlertId. The catalog is global: it lists every alert BambooHR offers and is not narrowed to the features the authenticated company has enabled, so a template appearing here does not guarantee that the company can configure it.

Use this to discover the bambooAlertId required by Create Alert Configuration (create-alert-configuration). For the alerts a company has already configured, use List Alert Configurations (list-alert-configurations) instead. Callers without view access to the company's Email Alerts settings receive 403 rather than a filtered result.

OAuth Scopes: alerts

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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