VUZDevelopers

Get notification preferences

GET
/notifications/preferences

Retrieves the full notification preferences for the current user, including:

Response Structure:

  • global: Global preferences that apply to all notifications
  • categories: Per-category preferences (documents, payments, expenses, business, system)
  • typeOverrides: Specific notification type overrides

Preference Cascade: Preferences are applied in the following order (most specific wins):

  1. Type-specific for business
  2. Type-specific global
  3. Business-level (all types)
  4. Global (all types, all businesses)
  5. System defaults

Use Cases:

  • Settings page for notification preferences
  • Display current preference state
  • Check which channels are enabled

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Response Body

application/json

curl -X GET "https://example.com/notifications/preferences"
{  "global": {    "id": "550e8400-e29b-41d4-a716-446655440000",    "userId": "550e8400-e29b-41d4-a716-446655440001",    "businessId": "string",    "notificationType": "document_created",    "inAppEnabled": true,    "emailEnabled": true,    "pushEnabled": false,    "emailDigestFrequency": "immediate",    "quietHoursStart": "22:00",    "quietHoursEnd": "08:00",    "timezone": "Asia/Jerusalem",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "categories": [    {      "category": "documents",      "displayName": "Documents",      "description": "Notifications about invoices, quotes, and other documents",      "inAppEnabled": true,      "emailEnabled": true,      "pushEnabled": false    }  ],  "typeOverrides": [    {      "id": "550e8400-e29b-41d4-a716-446655440000",      "userId": "550e8400-e29b-41d4-a716-446655440001",      "businessId": "string",      "notificationType": "document_created",      "inAppEnabled": true,      "emailEnabled": true,      "pushEnabled": false,      "emailDigestFrequency": "immediate",      "quietHoursStart": "22:00",      "quietHoursEnd": "08:00",      "timezone": "Asia/Jerusalem",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}