Setting

Mobile_API »Get Settings

Base URL

https://apimobile.callproof.com

Endpoint

/api/settings

Purpose

Retrieves a combined settings payload for the authenticated user and company, including user settings, company settings, dashboard widgets, tooltip flags, and AI agent configuration.

HTTP Method

GET

Headers

Header	Required	Description
Authorization	Yes	Bearer access token

Security

• Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

None.

cURL Example for Android

 curl --location 'https://apimobile.callproof.com/api/settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

 curl --location 'https://apimobile.callproof.com/api/settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

Successful Response (200)

Returns the combined settings payload.

Field	Type	Description
clientStatusCode	integer	Status indicator for the client (for example, 200)
user_id	integer	Identifier of the authenticated user
company_id	integer	Identifier of the authenticated user’s company
data	object	Settings payload (see below)
uri	string	Requested resource URI

data

Field	Type	Description
user_settings	object	User/company preference and feature flags for the mobile app
company_settings	object	Company-level widget/feature flags
widgets	object	Dashboard widget configuration
tooltip	object	Tooltip enablement flags by screen
agents	object/string	AI agent config (id, name), or empty when unavailable

data.user_settings

Field	Type	Description
manager	integer	Manager flag (1/0)
market_manager	integer	Market manager flag (1/0)
first_name	string	User first name
last_name	string	User last name
gps	integer	GPS setting value
is_sync_gps	integer	Whether GPS sync is enabled
sync_calls	integer	Call sync interval (seconds; default 3600 when unset)
sync_gps	integer	GPS sync interval (seconds; default 900 when unset)
people	integer	People-tab enabled flag (1/0)
event_form	integer	After-call event form ID (0 when none)
is_hide_mobile_appt_popup	integer	Hide mobile appointment popup flag
is_start_appointment	integer	Start appointment enabled flag
is_contact_page_as_homepage	integer	Contact page as homepage flag
is_logs_enabled	integer	Company logs enabled flag
is_automatic_logs_enabled	integer	Automatic logs enabled flag
event_form_id	integer	User-linked event form ID
is_delete_personnel	integer	Allow delete personnel flag
is_twilio_enabled	integer	Twilio enabled flag
is_videomessage_enabled	integer	Video message enabled flag
is_unread_videomessage	integer/boolean	Unread video message indicator
display_glass_usa_dashboard_btn	boolean	Whether Glass USA dashboard button is shown
omega_key	string	External key when Glass USA is configured
primary_location_search_type	integer/boolean	Primary location search type setting
background_image	string	Company background image URL
user_image	string	User profile image URL
logo	string	Company logo URL
isShowTaskPopup	boolean	Whether the task popup should be shown
introductory_video	string	Introductory video link
new_videos_count	integer	Count of new tutorial videos for the current day
is_2fa_enabled	boolean	Whether two-factor authentication is enabled for user or company
hide_my_events	boolean	Hide my events preference
is_business_card_widget_enabled	boolean	Business card widget enabled
is_ai_enabled	boolean/integer	Company AI enabled flag
chat_bot	integer	Chat bot enabled flag
ai_call_summary	integer	AI call summary enabled flag
ai_prompt_edit	integer	AI prompt edit enabled flag
ai_virtual_assistant	integer	AI virtual assistant enabled flag (when AI is enabled)

data.company_settings

Field	Type	Description
is_recommended_followup_enabled	boolean	Recommended follow-up feature enabled
is_task_widget_enabled	boolean	Task widget enabled
is_opportunity_widget_enabled	boolean	Opportunity widget enabled

data.widgets

Field	Type	Description
recommended_followup	integer	Recommended follow-up widget status
task_widget	integer	Task widget status
widgets	array	Active/ordered widgets
widgets_available	array	Inactive/available widgets

data.tooltip

Field	Type	Description
has_tooltip_enable	boolean	Master tooltip enable flag
home_screen	boolean	Home screen tooltip
accounts_screen	boolean	Accounts screen tooltip
route_screen	boolean	Route screen tooltip
places_screen	boolean	Places screen tooltip
places_filter_screen	boolean	Places filter screen tooltip
home_settings_screen	boolean	Home settings screen tooltip

data.agents

Field	Type	Description
id	string/integer	Agent identifier
name	string	Agent display name

Error Responses

Status Code	Meaning
400	Bad Request – settings could not be retrieved
401	Unauthorized – missing, invalid, or expired Bearer token

• 400 – An error occurred while loading settings.
• 401 – Authentication failed or the access token is missing/expired.