---
title: "Get notifications for the authenticated user"
method: GET
path: "/notifications"
tags: ["Notifications"]
---

# Get notifications for the authenticated user

`GET /notifications`

Returns the in-product notifications raised for the currently
authenticated user at the given site, ordered most recent first.
Use the optional filters to narrow by read status or type.

## Query parameters

- `site_id` string, uuid, required
- `read` boolean
- `type` string[]
- `page` integer
- `per_page` integer

## Response `200`

Notifications were successfully retrieved.

- object
  - `data` Notification[], required — The array of notifications.
    - `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.
  - `meta` NotificationsMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
    - `total_read` integer — The number of notifications that have been read.
    - `total_unread` integer — The number of notifications that have not been read.
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## 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)