Notifications

List notifications

GET/notifications
notifications:readlist_notificationsRead-only

Lists the acting user's own notifications, newest first; nobody else's can be read. status is unread until the user reads it. Narrow with filter[status]. Send totals=true for meta.totals: its unread counts every unread notification in the inbox, ignoring the filters and the page. Titles carry the platform's own wording. Changes nothing. Use POST /notifications/actions/mark-all-read to clear the unread count.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • totalsboolean#

    Send true to add meta.totals, with the number of unread notifications in the whole inbox, whatever the filters and the page.

  • sortstring#

    Comma-separated fields to sort by: created_at. Prefix a field with - for descending. Defaults to -created_at. The notification id is always the final tiebreak.

  • filter[status]string#

    unread lists the notifications not yet read, read lists the rest.

    One of: unread, read

Responses

200

The acting user's notifications.

NotificationListWithTotals
{
  "data": [
    {}
  ],
  "meta": {
    "totals": [
      {}
    ]
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/notifications\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"