UserSettings is a datatype for user settings.

Table: UserSettings

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Oct 29, 2025
defaultTimeZonestring  Long-TermDefault timezone preference for user. If not set, the default timezone is no longer taken from the organization.
featureAnnouncementsToShow[FeatureAnnouncement]yes PreviewList of feature announcements to show. See FeatureAnnouncement. This is a preview and subject to change.
isAutomaticHighlightingEnabledbooleanyes PreviewWhether automatic highlighting on the search page is enabled. This is a preview and subject to change.
isAutomaticSearchEnabledbooleanyes Short-TermWhether the automatic search been enabled.
isCommunityMessageDismissedbooleanyes Short-TermWhether the community message has been dismissed.
isDarkModeMessageDismissedbooleanyes Short-TermWhether the dark-mode message has been dismissed.
isEventListOrderedWithNewestAtBottombooleanyes Short-TermWhether there is an event list, ordered with newest last.
isFieldPanelOpenByDefaultbooleanyes Short-TermWhether the field panel is open by default.
isGettingStartedMessageDismissedbooleanyes Short-TermWhether the 'Getting Started' message has been dismissed.
isPackageDocsMessageDismissedbooleanyes Short-TermWhether the package documentation message has been dismissed.
isQuickStartCompletedbooleanyes Long-TermWhether the quick start has been completed.
isWelcomeMessageDismissedbooleanyes Short-TermWhether the welcome message has been dismissed.
starredDashboards[string]yes Long-TermList of dashboards that have been marked with a star.
starredSearchDomains[string]yes Long-TermList of searchdomains that have been marked with a star.
uiThemeUiThemeyes Long-TermThe user interface theme choice. See UiTheme.