Skip to content

Notifications

Read, mark, delete, and configure the notifications of the person who owns the credential, in one workspace.

These endpoints act as the key owner, in the workspace the credential is bound to. A personal API token selects the workspace with the X-Project-Feed-Workspace header. Notifications from every workspace are on the Identity API.

Session tokens can read and change your preferences for the workspace in X-Project-Feed-Workspace, including as a viewer, because they are your own settings.

Endpoints

Pagination

Use offset and limit to page through visible notifications. If hidden notifications stop a page before it is full, the response still returns the visible items collected so far, truncated true, and a nextCursor. Pass nextCursor until hasMore is false instead of increasing offset. Pages can be empty when older notifications are hidden. Actor objects carry several avatar fields; use image. See API conventions for cursors.

Workspace and account preferences

/api/v1/notifications/preferences works on one workspace and accepts a workspace API key or a personal API token. Saving there creates a workspace override of your account defaults.

/api/v1/me/notification-preferences works on your account defaults and needs a personal API token. It also lists your workspace overrides, read-only. It accepts more fields than the workspace endpoint: sound, tab indicator, and the chat settings.

Preferences are flat fields named by channel (email, push, inApp) and event, such as pushMention. globalMute and the quietHours fields apply to every channel.

Next steps

Image preview
100%