---
title: "GET /api/notifications/grouped"
method: GET
path: "/api/notifications/grouped"
---

# GET /api/notifications/grouped

`GET /api/notifications/grouped`

Get notifications grouped by type

## Query parameters

- `app` string[] — Return only notifications created by this app signers
- `before` object — Fetch newer notifications than the cursor
  - `us` string, required
  - `id` string, required
- `after` object — Fetch older notifications than the cursor
  - `us` string, required
  - `id` string, required
- `limit` integer — The number of notifications to return
- `type` string[] — Return only notifications of this type
- `user` union, required — The ENS name or address of the user
  - string — The Ethereum address of the user
  - unknown
- `seen` 'true' | 'false' | '1' | '0' — Whether to include only seen or unseen notifications, if omitted or empty all notifications will be included

## Response `200`

The notifications grouped by type

- object
  - `notifications` object[], required
    - `cursor` object, required
      - `us` string, required — A bigint string
      - `id` string, required — A bigint string
    - `groupedBy` object, required — Condition used to group notifications
      - `notificationType` 'reply' | 'mention' | 'reaction' | 'quote', required
      - `parent` object, required
        - `type` 'comment', required
        - `comment` object, required
          - `app` string, required — Hex format string, e.g. `0x1234567890abcdef`
          - `author` object, required
            - `address` string, required — Hex format string, e.g. `0x1234567890abcdef`
            - `ens` object
              - …
            - `farcaster` object
              - …
          - `id` string, required — Hex format string, e.g. `0x1234567890abcdef`
          - `channelId` string, required
          - `commentType` integer, required
          - `content` string, required
          - `chainId` integer, required
          - `deletedAt` string, nullable, required
          - `logIndex` integer, nullable, required
          - `metadata` object[], required
            - `key` string, required — Hex format string, e.g. `0x1234567890abcdef`
            - `value` string, required — Hex format string, e.g. `0x1234567890abcdef`
          - `hookMetadata` object[], required
            - `key` string, required — Hex format string, e.g. `0x1234567890abcdef`
            - `value` string, required — Hex format string, e.g. `0x1234567890abcdef`
          - `parentId` string, nullable, required — Hex format string, e.g. `0x1234567890abcdef`
          - `targetUri` string, required
          - `txHash` string, required — Hex format string, e.g. `0x1234567890abcdef`
          - `cursor` string, required — Hex format string, e.g. `0x1234567890abcdef`
          - `moderationStatus` 'approved' | 'rejected' | 'pending', required
          - `moderationStatusChangedAt` string, nullable, required
          - `moderationClassifierResult` object, required
          - `moderationClassifierScore` number, required
          - `createdAt` string, nullable, required
          - `updatedAt` string, nullable, required
          - `revision` integer, required
          - `zeroExSwap` object, nullable, required
            - `from` object, required
              - …
            - `to` object, required
              - …
          - `references` union[], required
            - union
              - …
          - `path` string, required
          - `viewerReactions` object, required
          - `reactionCounts` object, required
          - `replies` object, required
            - `extra` object, required
              - …
            - `pagination` object, required
              - …
            - `results` unknown[], required
              - …
    - `notifications` object, required
      - `notifications` object[], required
        - `cursor` object, required
          - `id` string, required — A bigint string
        - `notification` union, required
          - object
            - `type` 'reply', required
            - `replyingTo` object, required
              - …
            - `id` string, required — A bigint string
            - `createdAt` string, required — A date string in ISO 8601 format
            - `seen` boolean, required
            - `seenAt` string, required — A date string in ISO 8601 format
            - `app` string, required — Hex format string, e.g. `0x1234567890abcdef`
            - `author` object, required
              - …
            - `comment` object, required — The comment that has been created by the author. This comment triggered the notification.
              - …
          - object
            - `type` 'mention', required
            - `mentionedUser` object, required
              - …
            - `id` string, required — A bigint string
            - `createdAt` string, required — A date string in ISO 8601 format
            - `seen` boolean, required
            - `seenAt` string, required — A date string in ISO 8601 format
            - `app` string, required — Hex format string, e.g. `0x1234567890abcdef`
            - `author` object, required
              - …
            - `comment` object, required — The comment that has been created by the author. This comment triggered the notification.
              - …
          - object
            - `type` 'reaction', required
            - `reactingTo` object, required
              - …
            - `id` string, required — A bigint string
            - `createdAt` string, required — A date string in ISO 8601 format
            - `seen` boolean, required
            - `seenAt` string, required — A date string in ISO 8601 format
            - `app` string, required — Hex format string, e.g. `0x1234567890abcdef`
            - `author` object, required
              - …
            - `comment` object, required — The comment that has been created by the author. This comment triggered the notification.
              - …
          - object
            - `type` 'quote', required
            - `quotedComment` object, required
              - …
            - `id` string, required — A bigint string
            - `createdAt` string, required — A date string in ISO 8601 format
            - `seen` boolean, required
            - `seenAt` string, required — A date string in ISO 8601 format
            - `app` string, required — Hex format string, e.g. `0x1234567890abcdef`
            - `author` object, required
              - …
            - `comment` object, required — The comment that has been created by the author. This comment triggered the notification.
              - …
      - `pageInfo` object, required
        - `hasNextPage` boolean, required — Whether there are older notifications
        - `hasPreviousPage` boolean, required — Whether there are newer notifications
        - `startCursor` object — The cursor to the first notification
          - `id` string, required — A bigint string
        - `endCursor` object — The cursor to the last notification
          - `id` string, required — A bigint string
      - `extra` object, required
        - `unseenCount` string, required — The number of unseen notification groups
  - `pageInfo` object, required
    - `hasNextPage` boolean, required — Whether there are older notifications
    - `hasPreviousPage` boolean, required — Whether there are newer notifications
    - `startCursor` object — The cursor to the first notification
      - `us` string, required — A bigint string
      - `id` string, required — A bigint string
    - `endCursor` object — The cursor to the last notification
      - `us` string, required — A bigint string
      - `id` string, required — A bigint string
  - `extra` object, required
    - `unseenCount` string, required — The number of unseen notification groups

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — App not found
- `500` — Internal server error

---

[API](https://skmtc.net/ethcomments/apis/ethereum-comments-protocol-indexer-api.md) · [All operations](https://skmtc.net/ethcomments/apis/ethereum-comments-protocol-indexer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ethcomments/ethereum-comments-protocol-indexer-api/versions/9627e9d1ff21/schema)