Get Settings-info

Mobile_API » Get User Settings

Base URL

https://apimobile.callproof.com

Endpoint

/api/user-settings

Purpose

Retrieves the authenticated user’s combined user and company settings used by the mobile app (roles, sync intervals, feature flags, branding images, AI flags, and related preferences).

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/user-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

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

Successful Response (200)

Returns the user 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
uri	string	Requested resource URI

data.settings

Many boolean-style flags are returned as 1 (enabled) or 0 (disabled).

Field	Type	Description
manager	integer	Whether the user is a manager (1/0)
market_manager	integer	Whether the user is a market manager (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 in seconds (default 3600 when unset)
sync_gps	integer	GPS sync interval in seconds (default 900 when unset)
people	integer	Whether people tab is enabled for the company
event_form	integer	Default/related event form ID (0 when none)
is_hide_mobile_appt_popup	integer	Whether mobile appointment popup is hidden
is_start_appointment	integer	Whether start appointment is enabled
is_contact_page_as_homepage	integer	Whether contacts page is the homepage
is_logs_enabled	integer	Whether company logging is enabled
is_automatic_logs_enabled	integer	Whether automatic logs are enabled
event_form_id	integer	User’s event form ID setting
is_delete_personnel	integer	Whether personnel delete is allowed
is_twilio_enabled	integer	Whether Twilio is enabled for the company
is_videomessage_enabled	integer	Whether video messaging is enabled
is_unread_videomessage	integer/boolean	Whether the user has unread video messages
display_glass_usa_dashboard_btn	boolean	Whether Glass USA dashboard button is shown
omega_key	string	Omega key when Glass USA is configured; otherwise empty
primary_location_search_type	integer/boolean	Primary location search type setting for the company
background_image	string	Company background image URL (empty when none)
logo	string	Company logo URL (empty when none)
user_image	string	User profile/title image URL (empty when none)
isShowTaskPopup	boolean	Whether the task popup should be shown
introductory_video	string	Introductory video link
new_videos_count	integer	Count of new tutorial videos
is_2fa_enabled	boolean	Whether 2FA is enabled for the user or company
hide_my_events	boolean	Whether “my events” are hidden
is_business_card_widget_enabled	boolean	Whether the business card widget is enabled
is_ai_enabled	boolean	Whether AI is enabled at company level
chat_bot	integer	Chat bot setting (1/0; present when AI is enabled)
ai_call_summary	integer	AI call summary setting (1/0; present when AI is enabled)
ai_prompt_edit	integer	AI prompt edit setting (1/0; present when AI is enabled)
ai_virtual_assistant	integer	AI virtual assistant setting (1/0; present when AI is enabled)

Error Responses

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

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