---
title: "Get a grouped summary of notifications"
method: GET
path: "/grouped-notifications"
tags: ["Notifications"]
---

# Get a grouped summary of notifications

`GET /grouped-notifications`

Returns the in-product notifications for the currently
authenticated user, grouped by notification type. Use this view
to render the notification tray's collapsed-by-default layout —
`notifications` within each group contains the individual
records, and the top-level `meta` exposes read/unread counts and
per-type totals.

## Query parameters

- `site_id` string, required

## Response `200`

Notifications were successfully retrieved.

- object
  - `data` object[], required — The list of notification groups.
    - `type` string — The notification type discriminator the group is for.
    - `title` string — A human-readable title for the group.
    - `notifications` Notification[]
      - `id` string, uuid — The ID of the notification.
      - `title` string — A short headline summarising the notification.
      - `type` string — The machine-readable type discriminator for the notification. Used by clients to group, filter, or render notifications.
      - `subject_id` string — The ID of the entity the notification is about (e.g. the order or visit ID).
      - `subject_type` string — The type of the entity referenced by `subject_id` (e.g. `Order`, `Visit`).
      - `site_id` string, uuid — The ID of the site this notification relates to.
      - `created_at` string, date-time — The date and time the notification was created.
      - `read_at` string, date-time, nullable — The date and time the notification was read, or `null` if still unread.
      - `acknowledged_by` object, nullable — The user who acknowledged the notification, if any.
        - `id` string, uuid — The ID of the user who acknowledged the notification.
        - `name` string — The display name of the user who acknowledged the notification.
      - `data` object — The notification payload — a free-form object whose shape depends on the notification `type`.
      - `actions` object[] — A list of follow-up actions the recipient can take.
        - `label` string — The button label shown to the user.
        - `type` string — The machine-readable action discriminator.
        - `url` string — The URL the action should open.
    - `read` boolean — Whether every notification in the group has been read.
    - `count` integer — The number of notifications in the group.
    - `date` string, date-time — The date of the most recent notification in the group.
  - `meta` object, required
    - `total` integer — The total number of notifications across every group.
    - `counts` object — A map of notification type to count.
    - `total_read` integer — The number of notifications that have been read.
    - `total_unread` integer — The number of notifications that have not been read.

## Other responses

- `401` — The user is unauthenticated
- `403` — The authenticated user does not have permission.

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)