Query notifications and notification settings¶
Read the current user’s notifications and unread counts, and inspect delivery channels and rules. This task does not mark notifications as read, delete notifications, modify settings, or send test notifications.
Prerequisites¶
Prepare a personal access token. For authentication and query scope, see Usage and monitoring.
Call sequence¶
Query notifications and locate records by time range, category, or read status. Retrieve subsequent pages for complete results.
If you need an unread summary, independently query unread counts to obtain the total and category breakdowns.
To inspect delivery settings, query notification rules and channels. Match each rule’s delivery channels to the channel list and inspect enablement, priority, and read-only settings.
API operations¶
Read notifications¶
Task |
API operation |
When to use it or what to confirm |
|---|---|---|
Browse notification records |
Inspect notification content and read status. |
|
Inspect the unread summary |
Obtain unread totals and category breakdowns. |
Inspect delivery settings¶
Task |
API operation |
When to use it or what to confirm |
|---|---|---|
Inspect receiving channels |
Review in-app, email, and Webhook channel settings. |
|
Inspect trigger rules |
Review enablement, priority, thresholds, and delivery channels. |
Confirm the result¶
Use List notifications to confirm the target notification and its read status. For settings, match rule delivery channels against List notification channels. A configured channel does not prove that a particular notification was delivered successfully.
Limitations and notes¶
The notification list defaults to the last seven days. The number of records on one page is not the total unread count.
Returned channels or thresholds may be read-only; query results do not establish that they can be changed.
These operations only read notifications and settings. They do not mark notifications as read or trigger delivery.