UserNotificationList

A request or response body; the type column links to the schemas it refers to.

UserNotificationList

Field	Type	Required	Description
items	array of UserNotification	yes	—
page	integer	yes	minimum 1
page_size	integer	yes	minimum 1
total	integer	yes	Notifications the filter matches, across all pages. minimum 0
unread_count	integer	yes	The caller's unread notifications, whatever the filter. minimum 0

jsonExample

{
  "items": [
    {
      "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "kind": "trainee_digest",
      "title": "Certification deadlines: 1 overdue, 2 due in the next 60 days",
      "summary": "string",
      "href": "/dashboard",
      "sections": [
        {
          "key": "overdue",
          "heading": "Overdue (1)",
          "tone": "danger",
          "entries": [
            {
              "title": "Forklift Certification — Sep 3, 2026 (in 12 days)",
              "detail": "Workplace Safety · required by Forklift Operator (Warehouse) · Acme Corporation",
              "href": "/certifications/0b6c1c9e-08a1-4b55-a3a3-2b0e4bd8d2c1",
              "links": [
                {
                  "label": null,
                  "href": null,
                  "external": null
                }
              ]
            }
          ]
        }
      ],
      "created_at": "2026-01-01T00:00:00.000Z",
      "read_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0,
  "unread_count": 0
}