Skip to main content
GET
/
v1
/
deployments
/
{deploymentId}
/
notifications
List scheduled notifications
curl --request GET \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "cronExpression": "<string>",
      "dashboardId": 123,
      "deploymentId": 123,
      "humanReadableSchedule": "<string>",
      "id": 123,
      "isEnabled": true,
      "notificationEnabled": true,
      "notificationFormat": "<string>",
      "timezone": "<string>",
      "filters": [
        {
          "member": "<string>",
          "caseSensitive": null,
          "endInclusive": null,
          "startInclusive": null,
          "value": "<string>"
        }
      ],
      "timeGrains": [
        {
          "grain": "<string>",
          "member": "<string>"
        }
      ]
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}
🔒 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 the deployment’s scheduled notifications (recurring dashboard runs), ordered by creation time (newest first) and cursor-paginated. Optionally filter to a single dashboard with either dashboardId (numeric) or dashboardPublicId (string), and/or to the notifications a single recipient receives — a user (recipientUserId or recipientEmail) or an embed user (recipientEmbedTenantName + recipientExternalId). At most one identifier per dashboard/recipient dimension. Each item describes the schedule only; recipients are managed through the /recipients sub-resource.

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.

Query Parameters

​
dashboardId
integer

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.

Required range: x >= 1
​
dashboardPublicId
string

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.

​
recipientUserId
integer

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.

Required range: x >= 1
​
recipientEmail
string

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.

​
recipientEmbedTenantName
string

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.

​
recipientExternalId
string

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.

​
first
integer

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

Required range: 1 <= x <= 200
​
after
string

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

Response

200 - application/json
​
items
object[]
required
​
pageInfo
object | null