Skip to Content
MosaicMosaicDocs
Tool Reference

ListNotifications

List the current user's notifications.

Starter documentation. Features and account details may differ from this deployment.

ListNotifications

List the current user's notifications. By default returns active notifications (not deleted, not done), ordered by most recent first. Use states to select exact unseen, seen, or done states. Seen excludes done; an empty list includes all states.

Parameters

ParameterTypeRequiredDescription
limitintegerNoMaximum number of notifications to return. Defaults to 20, max 50.
states("unseen" | "seen" | "done")[]NoExact states to include: unseen, seen, done. Defaults to [unseen, seen]. An empty list includes all states.
includeTypes("email" | "message" | "channel" | "document" | "project" | "call" | "task" | "github" | "reminder" | "calendar" | "agent")[]NoFilter to specific notification item types. If omitted, returns all types. Example: ["email", "message"] returns only email and message notifications.
entitiesNotificationEntityFilter[]NoFilter to notifications for specific entities. Pair each id with its canonical entityType to avoid ambiguity. Example: [{"entityType":"email_thread","id":"..."}] returns notifications for one email thread.

On this page