Sign in
Notifications

Get a grouped summary of 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.

get/grouped-notifications

Query parameters

site_idstring required

Scope the notifications to a single Site. When not specified the platform falls back to the user's default site. Use this when a user works across multiple sites and you want their site-specific inbox.

Response

Notifications were successfully retrieved.

Example response

{
  "data": [
    {
      "title": "An order was created by rezlynx",
      "notifications": [
        {
          "id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
          "title": "An order was created by rezlynx",
          "type": "guestline_order_created",
          "subject_id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
          "subject_type": "Order",
          "site_id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
          "created_at": "2019-01-15T11:00:00.000Z",
          "read_at": "2019-01-15T11:00:00.000Z",
          "acknowledged_by": {
            "id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
            "name": "Jane Smith"
          },
          "actions": [
            {
              "label": "View order",
              "type": "view_order",
              "url": "https://app.try.be/orders/beddda88-947d-4bd8-8f0c-828b187f93b2"
            }
          ]
        }
      ],
      "read": true
    }
  ],
  "meta": {
    "total_read": 1,
    "total_unread": 1
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.