---
title: "GET /notifications"
method: GET
path: "/notifications"
tags: ["notification"]
---

# GET /notifications

`GET /notifications`

List a user notification

## Query parameters

- `notifyStates` 'unread' | 'read', required
- `cursor` string, nullable

## Response `200`

Successful response, return user notification list.

- object
  - `notifications` object[], required
    - `id` string, required
    - `notifyIcon` union, required
      - object
        - `iconUrl` string, required
      - object
        - `userId` string, required
        - `userName` string, required
        - `userAvatarUrl` string, nullable
    - `notifyType` 'system' | 'collaboratorCellTag' | 'collaboratorMultiRowTag' | 'comment' | 'exportBase', required
    - `url` string, required
    - `message` string, required
    - `messageI18n` string, nullable
    - `isRead` boolean, required
    - `createdTime` string, required
  - `nextCursor` string, nullable

---

[API](https://skmtc.net/teable/apis/teable-app.md) · [All operations](https://skmtc.net/teable/apis/teable-app/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/teable/teable-app/revisions/7515f3b33d79/schema)