Notifications

The notification inbox: listing, unread count, read and archive transitions, the accounting expert-group inbox address, and the devices a native push is addressed to.

📄️List inbox notifications

Returns the authenticated user's notifications for the given filter (inbox|unread|archived), newest first, cursor-paginated.

📄️Get accounting expert-group inbox email

Get accounting expert-group inbox email.

📄️Set accounting expert-group inbox email

Set accounting expert-group inbox email.

📄️Archive selected notifications

Archives the given notifications of the authenticated user in one request. Ids the user does not own are ignored; the response reports how many rows applied.

📄️Mark selected notifications read

Marks the given notifications of the authenticated user as read in one request. Ids the user does not own are ignored; the response reports how many rows applied.

📄️List how each notification type is delivered in this tenant

Returns every notification type the tenant configures, whether it is enabled, and the channels the configuration routes it to. Read-only: which notifications are sent, and over which channels, is an administrator's decision, and a recipient turns push off for the app in their operating system rather than here. The channels are read the way the send path reads the configuration, so a type routed away from the first-party system reports in-app only, and no type reports email while the tenant has notification email switched off. A listed channel is still not a promise of arrival: see the channels field. Answers the org-wide configuration; an organizational-unit override is not reflected, because a recipient can belong to several units and the answer is one list.

📄️Register a device for push notifications

Registers the calling user's device so notifications can also reach it as a native push. Idempotent on the token: repeating the call refreshes the registration, and a token last registered by another user is moved to the caller, which is what a shared or resold handset needs. Clients are expected to call this on launch and whenever the provider rotates the token.

📄️Deregister a device

Removes the calling user's registration for one device token, so the device stops receiving their push notifications. Clients call this on logout and when switching user. A token that is already gone succeeds as well: the caller asked for the device not to be registered, and it is not.

📄️Mark all notifications read

Marks every unread, non-archived notification of the authenticated user as read.

📄️Mark a case's notifications read

Marks the authenticated user's unread notifications for the given entity codes (a purchase request and/or purchase order) as read, optionally narrowed to notification types. Lets a client clear a case's badges when the user opens it, without knowing which notification ids back them. Codes the user holds no notifications for are ignored; the response reports how many rows applied.

📄️Get a notification

Returns one of the authenticated user's notifications by id, whether read, unread or archived. A push notification carries only this id, so a client opens the notification it was tapped for through this endpoint. Reading it does not mark it read. An id that belongs to another user answers 404, the same as an id that does not exist.