---
title: "Get notifications"
method: GET
path: "/api/v1/notifications"
tags: ["Notifications"]
---

# Get notifications

`GET /api/v1/notifications`

Gets notifications for a user based on the type

## Query parameters

- `type` 'dashboardComments' | 'aiReview', required

## Response `200`

Success

- ApiGetNotifications
  - `results` Notification[], required
    - union
      - NotificationDashboardComment
        - `url` string
        - `message` string
        - `resourceUuid` string
        - `viewed` boolean, required
        - `createdAt` string, date-time, required
        - `notificationId` string, required
        - `metadata` NotificationDashboardTileCommentMetadata
          - `dashboardUuid` string, required
          - `dashboardName` string, required
          - `dashboardTileUuid` string, required
          - `dashboardTileName` string, required
        - `resourceType` 'dashboardComments', required
      - NotificationAiReview
        - `url` string
        - `message` string
        - `resourceUuid` string
        - `viewed` boolean, required
        - `createdAt` string, date-time, required
        - `notificationId` string, required
        - `metadata` object, required
          - `searchParams` string, required
          - `count` number, double, required
          - `projectUuid` string, required
          - `rootCause` string, required
          - `title` string, required
          - `event` 'needs_review' | 'assigned', required
          - `fingerprint` string, required
        - `resourceType` 'aiReview', required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/revisions/40c933755c9a/schema)