v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Alert Configurations

Public API

Get an alert configuration

Returns a single company alert configuration by ID.

OAuth Scopes: alerts

get/api/v1/alert-configurations/{id}

Path parameters

idinteger required

Response

Alert configuration

idinteger

The unique identifier of the company alert.

bambooAlertIdinteger

The unique identifier of the Bamboo alert.

schedule'daily' | 'weekly' | 'monthly' | 'quarterly'

The schedule for the company alert.

dueWithininteger nullable

The number of days before the alert is due.

dueIntervalstring nullable

The interval for the alert.

sendToEmployeeboolean

Whether the alert should be sent to employees.

sendToManagerboolean

Whether the alert should be sent to managers.

sendToAdminboolean

Whether the alert should be sent to admins.

editorUserIdinteger nullable

The user ID of the editor.

{"stackTrail":"components:schemas:CompanyAlertDataObject:properties:lastEdited","oasType":"schema","type":"unknown","description":"The last edited date of the company alert."}

customMessagestring nullable

The custom message for the company alert.

customSubjectstring nullable

The custom subject for the company alert.

groupBystring nullable

The group by for the company alert.

limitTrainingToRequiredboolean

Whether the training should be limited to required training.

runAtTimestring nullable

The time the company alert should run at.

runAtTimeZonestring nullable

The time zone the company alert should run at.

includePositionboolean

Whether the alert should include position.

includeLocationboolean

Whether the alert should include location.

additionalRecipientEmailsstring[]

The additional recipient emails for the company alert.

employeeIdsstring[]

The employee IDs for the company alert.

listValueIdsinteger[]

The list value IDs for the company alert.

filterListValueIdsinteger[]

The filter list value IDs for the company alert.

userIdsinteger[]

The user IDs for the company alert.