Sign in
settings

Get Notification Preferences

Each product notification type with the user's effective on/off state.

get/settings/notifications/preferences

Response

Successful Response

notification_typestring required
labelstring required
descriptionstring required
group'Issues' | 'Intake' | 'Reviews' | 'Key Dates' | 'Follow Ups' required

Section a notification is listed under in the preference UI.

Named for the surface the notification is about, matching the sidebar, so a new type joins an existing section rather than lengthening one flat list.

enabledboolean required
supports_assigned_scopeboolean
assigned_scope_labelstring nullable
scope'all' | 'assigned'

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'

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 2 revisions of this API.