internal

List User Notification Preferences

A user's effective preference per notification type, for admin review.

get/internal/notifications/users/{user_id}/preferences

Path parameters

user_idstring uuid required

Response

Successful Response

notification_typestring required

labelstring required

descriptionstring required

required_permissionstring nullable required

permittedboolean required

enabledboolean required

supports_assigned_scopeboolean required

assigned_scope_labelstring nullable required

scope'all' | 'assigned' required

How widely a user wants to receive a (scope-supporting) notification.

ALL means every event of this type at the company; ASSIGNED narrows it to the subset that concerns the user. What "assigned" resolves to is defined by the definition's AssignedScopeSpec.kind.

default_scope'all' | 'assigned' required

How widely a user wants to receive a (scope-supporting) notification.

ALL means every event of this type at the company; ASSIGNED narrows it to the subset that concerns the user. What "assigned" resolves to is defined by the definition's AssignedScopeSpec.kind.

Changes

No recorded changes to this endpoint across all 1 revision of this API.