Difference between revisions of "Get User Settings Info"

From docs
Jump to: navigation, search
(Created page with "== Get User Settings Info == === Base URL === https://apimobile.callproof.com === Endpoint === /api/user/{latitude}/{longitude}/setting === Purpose === Retrieves the authen...")
 
(Successful Response (200))
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
== Get User Settings Info ==
+
== [[Mobile_API]] »Get User Settings Info ==
  
 
=== Base URL ===
 
=== Base URL ===
Line 39: Line 39:
 
==== Request Body ====
 
==== Request Body ====
 
None.
 
None.
 +
 +
=== cURL Example for Android ===
 +
 +
<pre> curl --location 'https://apimobile.callproof.com/api/user/YOUR_LATITUDE/YOUR_LONGITUDE/setting' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>
 +
 +
=== cURL Example for iOS ===
 +
 +
<pre> curl --location 'https://apimobile.callproof.com/api/user/YOUR_LATITUDE/YOUR_LONGITUDE/setting' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>
  
 
=== Successful Response (200) ===
 
=== Successful Response (200) ===

Latest revision as of 12:45, 20 July 2026

Mobile_API »Get User Settings Info

Base URL

https://apimobile.callproof.com

Endpoint

/api/user/{latitude}/{longitude}/setting

Purpose

Retrieves the authenticated user’s combined user and company settings for the mobile app. Includes feature flags, sync intervals, branding images, AI feature toggles, and Google Places search coordinates derived from the provided latitude/longitude (with fallbacks when coordinates are zero).

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter Type Required Description
latitude number/string Yes Current latitude used for Google Places search location (use 0 to fall back to profile/last-login/default location)
longitude number/string Yes Current longitude used for Google Places search location (use 0 to fall back to profile/last-login/default location)

Query Parameters

None.

Request Body

None.

cURL Example for Android

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

cURL Example for iOS

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

Successful Response (200)

Returns user/company settings under data.settings. Many feature flags are returned as 1 (enabled) or 0 (disabled).

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

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-related user setting value
is_sync_gps integer Whether GPS sync is enabled (1/0)
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 mode is enabled for the company (1/0)
event_form integer Default event form ID (0 when none)
is_hide_mobile_appt_popup integer Whether appointment popup is hidden (1/0)
is_start_appointment integer Whether start appointment is enabled (1/0)
is_contact_page_as_homepage integer Whether contacts page is homepage (1/0)
is_logs_enabled integer Whether company logs are enabled (1/0)
is_automatic_logs_enabled integer Whether automatic logs are enabled (1/0)
event_form_id integer User’s event form ID setting
is_delete_personnel integer Whether personnel delete is allowed (1/0)
is_twilio_enabled integer Whether Twilio is enabled for the company (1/0)
is_videomessage_enabled integer Whether video messaging is enabled (1/0)
is_unread_videomessage mixed Unread video message indicator/count for the user
display_glass_usa_dashboard_btn boolean Whether Glass USA dashboard button should be shown
omega_key string Glass USA / omega key when applicable (empty when not)
primary_location_search_type mixed Primary location search type setting for the company
google_place_search_latitude number Latitude used for Google Places search
google_place_search_longitude number Longitude used for Google Places search
background_image string Company background image URL (empty when none)
user_image string User profile/title image URL (empty when none)
logo string Company logo URL (empty when none)
isShowTaskPopup boolean Whether the task popup should be shown
introductory_video string Introductory/tutorial video link (empty when none)
new_videos_count integer Count of tutorial videos created today (user timezone)
is_2fa_enabled boolean Whether 2FA is enabled for the user or company
hide_my_events boolean Whether “hide my events” is enabled
is_business_card_widget_enabled boolean Whether the business card widget is enabled
is_ai_enabled mixed Whether AI is enabled at company level
chat_bot integer Chat bot AI setting (1/0; present when AI is enabled)
ai_call_summary integer AI call summary setting (1/0)
ai_prompt_edit integer AI prompt edit setting (1/0)
ai_virtual_assistant integer AI virtual assistant setting (1/0; when AI 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/company settings.
  • 401 – Authentication failed or the access token is missing/expired.