This method returns the preference setting for the owner of the provided token.
This method has the URL https://slack.com/api/users.prefs.get and follows the Slack Web API calling conventions.
| Argument | Example | Required | Description |
|---|---|---|---|
token |
xxxx-xxxxxxxxx-xxxx |
Required | Authentication token (Requires scope: read, needs client token) |
If successful you will receive the updates file object as JSON.
{
"ok": true,
"prefs": {
"highlight_words": "",
"user_colors": "",
"color_names_in_list": true,
"growls_enabled": true,
"tz": "Europe/Amsterdam",
"push_dm_alert": true,
"push_mention_alert": true,
"msg_replies": { "flexpane":false },
"push_everything": false,
"push_idle_wait": 2,
"push_sound": "b2.mp3",
"push_loud_channels": "",
"push_mention_channels": "",
"push_loud_channels_set": "",
"email_alerts": "none",
"email_alerts_sleep_until": 0,
"email_misc": false,
"email_weekly": true,
"welcome_message_hidden": false,
"all_channels_loud": false,
"loud_channels": "",
"never_channels": "",
"loud_channels_set": "",
"show_member_presence": true,
"search_sort": "timestamp",
"expand_inline_imgs": true,
"expand_internal_inline_imgs": true,
"expand_snippets": false,
"posts_formatting_guide": true,
"seen_welcome_2": true,
"seen_ssb_prompt": false,
"spaces_new_xp_banner_dismissed": true,
"search_only_my_channels": false,
"emoji_mode": "default",
"emoji_use": {"simple_smile":161,"+1":64,"rocket":4,"smiley":6,"smile":25,"dog":1,"gift":1,"grinning":15,"imp":1,"angel":1,"thinking_face":2,"money_mouth_face":1,"grey_question":1,"confounded":1,"heart_eyes":11,"grimacing":2,"stuck_out_tongue":4,"wink":8,"newspaper":2,"relaxed":1,"laughing":1,"one":4,"pirate":8,"doom":4,"zombie":3,"beard":2,"meathead":1,"nerd":2,"spongey":1,"stoned":2,"thug":3,"angrybirds":1,"mario":1,"mariohead":1,"redskull":1,"rofl":9,"shrug":2,"nerd_face":2,"innocent":1,"smirk":9,"muscle":3,"boom":7,"joy":5,"new":1,"pirateflag":3,"birthday":1,"disappointed":7,"metal":3,"smiling_imp":1,"hulk":2,"angry":1,"spaghetti":2,"flag-de":2,"confetti_ball":1,"slightly_smiling_face":100,"+1::skin-tone-3":1,"two":2,"clap":1,"towel":1,"awesomeface":5,"allthethings":2,"awesome-face-cylon":2,"bacon":2,"brain":2,"cabbage":2,"caduceus-cure":2,"crazy":3,"daft-punk-manuel":2,"daft-punk-thomas":4,"dna":2,"fingers-crossed":3,"fly":2,"guy-fawkes":3,"martini":2,"molotov-cocktail":2,"occupy":1,"power-switch":1,"snoop-dog":1,"steak":1,"walter-white":1,"spr":2,"vregs":2,"ri0t":1,"mutts":2,"hugging_face":1},
"has_invited": true,
"has_uploaded": true,
"has_created_channel": true,
"search_exclude_channels": "",
"messages_theme": "light_with_avatars",
"webapp_spellcheck": true,
"no_joined_overlays": true,
"no_created_overlays": true,
"dropbox_enabled": false,
"seen_domain_invite_reminder": false,
"seen_member_invite_reminder": false,
"mute_sounds": false,
"arrow_history": false,
"tab_ui_return_selects": true,
"obey_inline_img_limit": true,
"new_msg_snd": "b2.mp3",
"require_at": false,
"ssb_space_window": "",
"mac_ssb_bounce": "",
"mac_ssb_bullet": true,
"expand_non_media_attachments": true,
"show_typing": true,
"pagekeys_handled": true,
"last_snippet_type": "text",
"display_real_names_override": 0,
"display_preferred_names": true,
"time24": false,
"enter_is_special_in_tbt": false,
"graphic_emoticons": false,
"convert_emoticons": true,
"autoplay_chat_sounds": true,
"ss_emojis": true,
"sidebar_behavior": "",
"seen_onboarding_start": false,
"onboarding_cancelled": false,
"seen_onboarding_slackbot_conversation": false,
"seen_onboarding_channels": false,
"seen_onboarding_direct_messages": false,
"seen_onboarding_invites": false,
"seen_onboarding_search": false,
"seen_onboarding_recent_mentions": false,
"seen_onboarding_starred_items": false,
"seen_onboarding_private_groups": false,
"onboarding_slackbot_conversation_step": 0,
"dnd_enabled": true,
"dnd_start_hour": "23:00",
"dnd_end_hour": "09:00",
"mark_msgs_read_immediately": true,
"start_scroll_at_oldest": true,
"snippet_editor_wrap_long_lines": true,
"ls_disabled": false,
"sidebar_theme": "ocean_theme",
"sidebar_theme_custom_values": {"column_bg":"#303E4D","menu_bg":"#2C3849","active_item":"#6698C8","active_item_text":"#FFFFFF","hover_item":"#4A5664","text_color":"#FFFFFF","active_presence":"#94E864","badge":"#78AF8F"},
"f_key_search": false,
"k_key_omnibox": true,
"speak_growls": false,
"mac_speak_voice": "com.apple.speech.synthesis.voice.Alex",
"mac_speak_speed": 250,
"comma_key_prefs": false,
"at_channel_suppressed_channels": "",
"push_at_channel_suppressed_channels": "",
"prompted_for_email_disabling": false,
"full_text_extracts": false,
"no_text_in_notifications": false,
"muted_channels": "C0XGCTZHU",
"no_macssb1_banner": false,
"no_macssb2_banner": false,
"no_winssb1_banner": true,
"no_omnibox_in_channels": false,
"k_key_omnibox_auto_hide_count": 0,
"hide_user_group_info_pane": false,
"mentions_exclude_at_user_groups": false,
"privacy_policy_seen": true,
"search_exclude_bots": false,
"load_lato_2": false,
"fuller_timestamps": false,
"last_seen_at_channel_warning": 1464287715257,
"flex_resize_window": false,
"msg_preview": false,
"msg_preview_displaces": true,
"msg_preview_persistent": true,
"emoji_autocomplete_big": false,
"winssb_run_from_tray": true,
"winssb_window_flash_behavior": "idle",
"two_factor_auth_enabled": false,
"two_factor_type": null,
"two_factor_backup_type": null,
"enhanced_debugging": false,
"mentions_exclude_at_channels": true,
"confirm_clear_all_unreads": true,
"confirm_user_marked_away": true,
"box_enabled": false,
"seen_single_emoji_msg": true,
"confirm_sh_call_start": true,
"preferred_skin_tone": "",
"show_all_skin_tones": false,
"separate_private_channels": false,
"whats_new_read": 1463590800,
"hotness": false,
"frecency_jumper": "",
"jumbomoji": true,
"no_flex_in_history": true,
"newxp_seen_last_message": "1",
"attachments_with_borders": false,
"sticky_unread_divider": false,
"priority_sort": false,
"custom_channel_sort": "",
"a11y_font_size": "normal"
}In case of errors you will receive a standard Slack API response in JSON as described here.
| Error | Description |
|---|---|
| tbd |