v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB
Notification Preferences

Get account notification preferences

Returns the account notification settings for the API key's own user in the active company, along with the modes each event supports and the platform defaults. Every event is always present; an event the user has never configured reports its default. There is no way to read another member's preferences through this API. Requires account:read.

get/notification-preferences

Response

Notification preferences returned

successboolean
supportedModesobject

Modes each event accepts, keyed by event.

defaultsobject

Mode each event uses when the user has never configured it.