Skip to navigation

List notifications

View as MarkdownOpen in Claude

Returns the persistent notification log for the operator, ordered by sentAt descending by default. Filter by category, delivery status, or read-state. Use the cursor returned in pagination.cursor to step through pages. For real-time delivery, subscribe to the SSE stream endpoint instead of polling.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

cursorstringOptional
Opaque cursor returned from a prior call.
limitdoubleOptional1-100
Maximum number of results to return. Defaults to 20.
sortBystringOptional
Sort field. Defaults to sentAt.
sortOrderenumOptional
Sort order. Defaults to desc.
Allowed values:
categorystringOptional

Filter by notification category (e.g., alert.threshold_breach).

statusenumOptional
Filter by delivery lifecycle status.
Allowed values:
unreadbooleanOptional
When true, return only unread notifications.

Response

A cursor-paginated page of notifications.

datalist of objects
Notifications for this page, ordered by sentAt descending by default.
paginationobject
Cursor metadata for paging forward.