v7

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01120263252.9 KB
Notifications

List scheduled notifications

get/api/v1/deployments/{deploymentId}/notifications

Path parameters

deploymentIdinteger required

Numeric id of the deployment that owns the notification.

Query parameters

dashboardIdinteger nullable

Optional filter: only return notifications for this numeric dashboard id. Provide this OR dashboardPublicId, not both.

Optional filter: only return notifications for this numeric dashboard id. Provide this OR dashboardPublicId, not both.

dashboardPublicIdstring nullable

Optional filter: only return notifications for this dashboard public id. Provide this OR dashboardId, not both.

Optional filter: only return notifications for this dashboard public id. Provide this OR dashboardId, not both.

recipientUserIdinteger nullable

Optional filter: only return notifications received by this user, by user id. Mutually exclusive with recipientEmail and the embed-user filter.

Optional filter: only return notifications received by this user, by user id. Mutually exclusive with recipientEmail and the embed-user filter.

recipientEmailstring nullable

Optional filter: only return notifications received by this user, by email. Mutually exclusive with recipientUserId and the embed-user filter.

Optional filter: only return notifications received by this user, by email. Mutually exclusive with recipientUserId and the embed-user filter.

recipientEmbedTenantNamestring nullable

Optional filter: only return notifications received by this embed user. Required together with recipientExternalId; mutually exclusive with the user filters.

Optional filter: only return notifications received by this embed user. Required together with recipientExternalId; mutually exclusive with the user filters.

recipientExternalIdstring nullable

Optional filter: only return notifications received by this embed user. Required together with recipientEmbedTenantName; mutually exclusive with the user filters.

Optional filter: only return notifications received by this embed user. Required together with recipientEmbedTenantName; mutually exclusive with the user filters.

firstinteger

Page size for cursor pagination (default 100, max 200).

afterstring

Opaque cursor for the next page; pass the previous response's pageInfo.endCursor.

Response