Skip to main content
GET
Get a scheduled notification
🔒 Admin only. Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role. Returns a single scheduled notification by id, including its cron expression, timezone, enabled state, notification format, and a human-readable schedule summary. Returns 404 if the notification does not exist or does not belong to this deployment.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
integer
required

Numeric id of the deployment that owns the notification.

id
integer
required

Numeric id of the notification (scheduled run).

Response

200 - application/json
cronExpression
string
required
dashboardId
integer
required
deploymentId
integer
required
humanReadableSchedule
string
required

Human-readable description of the cron schedule

id
integer
required
isEnabled
boolean
required
notificationEnabled
boolean
required
notificationFormat
string
required
timezone
string
required
filters
object[] | null

Dimension filters applied when the notification is rendered.

timeGrains
object[] | null

Time-grain overrides applied when the notification is rendered.