Show Settings

GET {{baseUrl}}/api/v2/account/settings

Shows the settings that are available for the account.

Allowed For

  • Agents

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"settings":{"active_features":{"advanced_analytics":false,"agent_forwarding":false,"allow_ccs":true,"allow_email_template_customization":true,"automatic_answers":false,"bcc_archiving":false,"benchmark_opt_out":false,"business_hours":false,"chat":false,"chat_about_my_ticket":false,"csat_reason_code":false,"custom_dkim_domain":true,"customer_context_as_default":false,"customer_satisfaction":false,"dynamic_contents":false,"explore":true,"explore_on_support_ent_plan":false,"explore_on_support_pro_plan":false,"facebook":false,"facebook_login":false,"fallback_composer":false,"forum_analytics":true,"good_data_and_explore":false,"google_login":false,"insights":false,"is_abusive":false,"light_agents":false,"markdown":false,"on_hold_status":false,"rich_content_in_emails":true,"sandbox":false,"satisfaction_prediction":false,"suspended_ticket_notification":false,"ticket_forms":true,"ticket_tagging":true,"topic_suggestion":false,"twitter":true,"twitter_login":false,"user_org_fields":true,"user_tagging":true,"voice":true},"agents":{"agent_workspace":false,"aw_self_serve_migration_enabled":true,"focus_mode":false,"idle_timeout_enabled":false,"unified_agent_statuses":false},"api":{"accepted_api_agreement":true,"api_password_access":"true","api_token_access":"true"},"apps":{"create_private":true,"create_public":false,"use":true},"billing":{"backend":"zuora"},"branding":{"favicon_url":null,"header_color":"78A300","header_logo_url":null,"page_background_color":"333333","tab_background_color":"7FA239","text_color":"FFFFFF"},"brands":{"default_brand_id":1873,"require_brand_on_new_tickets":false},"cdn":{"cdn_provider":"default","fallback_cdn_provider":"cloudfront","hosts":[{"name":"default","url":"https://p18.zdassets.com"},{"name":"cloudfront","url":"https://d2y9oszrd3dhjh.cloudfront.net"}]},"chat":{"available":true,"enabled":false,"integrated":true,"maximum_request_count":1,"welcome_message":"Hi there. How can I help today?"},"cross_sell":{"show_chat_tooltip":true,"xsell_source":null},"gooddata_advanced_analytics":{"enabled":true},"google_apps":{"has_google_apps":false,"has_google_apps_admin":false},"groups":{"check_group_name_uniqueness":true},"limits":{"attachment_size":52428800},"localization":{"locale_ids":[1042]},"lotus":{"pod_id":999,"prefer_lotus":true,"reporting":true},"metrics":{"account_size":"100-399"},"onboarding":{"checklist_onboarding_version":2,"onboarding_segments":null,"product_sign_up":null},"routing":{"autorouting_tag":"","enabled":false,"max_email_capacity":0,"max_messaging_capacity":0},"rule":{"macro_most_used":true,"macro_order":"alphabetical","skill_based_filtered_views":[],"using_skill_based_routing":false},"side_conversations":{"show_in_context_panel":false},"statistics":{"forum":true,"rule_usage":true,"search":true},"ticket_form":{"raw_ticket_forms_instructions":"Please choose your issue below","ticket_forms_instructions":"Please choose your issue below"},"ticket_sharing_partners":{"support_addresses":["support@grokpetre.zendesk.com"]},"tickets":{"accepted_new_collaboration_tos":false,"agent_collision":true,"agent_ticket_deletion":false,"allow_group_reset":true,"assign_default_organization":true,"assign_tickets_upon_solve":true,"auto_updated_ccs_followers_rules":false,"collaboration":true,"comments_public_by_default":true,"email_attachments":false,"emoji_autocompletion":true,"follower_and_email_cc_collaborations":false,"has_color_text":true,"is_first_comment_private_enabled":true,"light_agent_email_ccs_allowed":false,"list_empty_views":true,"list_newest_comments_first":true,"markdown_ticket_comments":false,"maximum_personal_views_to_list":8,"private_attachments":false,"rich_text_comments":true,"status_hold":false,"tagging":true,"using_skill_based_routing":false},"twitter":{"shorten_url":"optional"},"user":{"agent_created_welcome_emails":true,"end_user_phone_number_validation":false,"have_gravatars_enabled":true,"language_selection":true,"multiple_organizations":false,"tagging":true,"time_zone_selection":true},"voice":{"agent_confirmation_when_forwarding":true,"agent_wrap_up_after_calls":true,"enabled":true,"logging":true,"maximum_queue_size":5,"maximum_queue_wait_time":1,"only_during_business_hours":false,"outbound_enabled":true,"recordings_public":true,"uk_mobile_forwarding":true}}}