---
title: "List scheduled notifications"
method: GET
path: "/api/v1/deployments/{deploymentId}/notifications"
tags: ["Notifications"]
---

# List scheduled notifications

`GET /api/v1/deployments/{deploymentId}/notifications`

## Path parameters

- `deploymentId` integer, required

## Query parameters

- `dashboardId` integer, nullable — Optional filter: only return notifications for this numeric dashboard id. Provide this OR dashboardPublicId, not both.
- `dashboardPublicId` string, nullable — Optional filter: only return notifications for this dashboard public id. Provide this OR dashboardId, not both.
- `recipientUserId` integer, nullable — Optional filter: only return notifications received by this user, by user id. Mutually exclusive with recipientEmail and the embed-user filter.
- `recipientEmail` string, nullable — Optional filter: only return notifications received by this user, by email. Mutually exclusive with recipientUserId and the embed-user filter.
- `recipientEmbedTenantName` string, nullable — Optional filter: only return notifications received by this embed user. Required together with recipientExternalId; mutually exclusive with the user filters.
- `recipientExternalId` string, nullable — Optional filter: only return notifications received by this embed user. Required together with recipientEmbedTenantName; mutually exclusive with the user filters.
- `first` integer
- `after` string

## Response `200`

- NotificationsListResponse
  - `items` NotificationDto[], required
    - `cronExpression` string, required
    - `dashboardId` integer, required
    - `deploymentId` integer, required
    - `filters` DashboardFilter[], nullable — Dimension filters applied when the notification is rendered.
      - `caseSensitive` unknown
      - `endInclusive` unknown
      - `member` string, required
      - `operator` 'equals' | 'not_equals' | 'greater_than' | 'greater_than_or_equal' | 'less_than' | 'less_than_or_equal' | 'contains' | 'not_contains' | 'starts_with' | 'not_starts_with' | 'ends_with' | 'not_ends_with' | 'is_null' | 'is_not_null' | 'is_empty' | 'is_not_empty' | 'between' | 'custom'
      - `startInclusive` unknown
      - `value` union
        - string
        - number
        - boolean
        - unknown[]
          - unknown
    - `humanReadableSchedule` string, required — Human-readable description of the cron schedule
    - `id` integer, required
    - `isEnabled` boolean, required
    - `notificationEnabled` boolean, required
    - `notificationFormat` string, required
    - `timeGrains` DashboardTimeGrain[], nullable — Time-grain overrides applied when the notification is rendered.
      - `grain` string, required
      - `member` string, required
    - `timezone` string, required
  - `pageInfo` PageInfo
    - `endCursor` string, nullable
    - `hasNextPage` boolean, required
    - `hasPreviousPage` boolean, required
    - `startCursor` string, nullable

---

[API](https://skmtc.net/cube-js/apis/cube-cloud-rest-api.md) · [All operations](https://skmtc.net/cube-js/apis/cube-cloud-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cube-js/cube-cloud-rest-api/revisions/a0c6b1d2ac96/schema)