Notifications
List notifications
Return in-app notifications, newest first, with the unread count.
Returns the workspace notifications (handoffs, failures, billing and channel alerts) and the total unread count in meta.unreadCount. Use it to see what needs attention. Read-only. Paginated: follow meta.pagination.nextCursor until hasMore is false.
query Parameters
limitRows to return, 1-100. Defaults to 25.
Rows to return, 1-100. Defaults to 25.
cursorThe meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
The meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
unreadOnlytrue returns only unread notifications. Defaults to false.
true returns only unread notifications. Defaults to false.
List notifications › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successMark all notifications read
Mark every unread notification as read.
Clears the unread badge by marking every notification as read. Use it only when the user asked to dismiss everything; to dismiss one, use notifications.read. Changes the read state only, deletes nothing and sends nothing.
Mark all notifications read › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successMark a notification read
Mark one notification as read.
Marks a single notification as read so it stops counting as unread. Use it after the notification has been handled. Changes the read state only, deletes nothing and sends nothing.
path Parameters
idNotification id from notifications.list.
Notification id from notifications.list.
Mark a notification read › Responses
The API key is missing, malformed, expired, or its owner is inactive.
success