Ashley DeBon: /* Successful Response (200) */

2026-07-20T12:45:48Z

‎Successful Response (200)

Ashley DeBon: /* Get User Settings Info */

2026-07-20T12:44:20Z

‎Get User Settings Info

Ashley DeBon: Created page with "== Get User Settings Info == === Base URL === https://apimobile.callproof.com === Endpoint === /api/user/{latitude}/{longitude}/setting === Purpose === Retrieves the authen..."

2026-07-20T12:44:00Z

Created page with "== Get User Settings Info == === Base URL === https://apimobile.callproof.com === Endpoint === /api/user/{latitude}/{longitude}/setting === Purpose === Retrieves the authen..."

New page

== 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 ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| latitude || number/string || Yes || Current latitude used for Google Places search location (use <code>0</code> to fall back to profile/last-login/default location)
|-
| longitude || number/string || Yes || Current longitude used for Google Places search location (use <code>0</code> to fall back to profile/last-login/default location)
|}

==== Query Parameters ====
None.

==== Request Body ====
None.

=== Successful Response (200) ===
Returns user/company settings under <code>data.settings</code>. Many feature flags are returned as <code>1</code> (enabled) or <code>0</code> (disabled).

{| class="wikitable"
! 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 ====
{| class="wikitable"
! Field !! Type !! Description
|-
| manager || integer || Whether the user is a manager (<code>1</code>/<code>0</code>)
|-
| market_manager || integer || Whether the user is a market manager (<code>1</code>/<code>0</code>)
|-
| 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 (<code>1</code>/<code>0</code>)
|-
| 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 (<code>1</code>/<code>0</code>)
|-
| event_form || integer || Default event form ID (0 when none)
|-
| is_hide_mobile_appt_popup || integer || Whether appointment popup is hidden (<code>1</code>/<code>0</code>)
|-
| is_start_appointment || integer || Whether start appointment is enabled (<code>1</code>/<code>0</code>)
|-
| is_contact_page_as_homepage || integer || Whether contacts page is homepage (<code>1</code>/<code>0</code>)
|-
| is_logs_enabled || integer || Whether company logs are enabled (<code>1</code>/<code>0</code>)
|-
| is_automatic_logs_enabled || integer || Whether automatic logs are enabled (<code>1</code>/<code>0</code>)
|-
| event_form_id || integer || User’s event form ID setting
|-
| is_delete_personnel || integer || Whether personnel delete is allowed (<code>1</code>/<code>0</code>)
|-
| is_twilio_enabled || integer || Whether Twilio is enabled for the company (<code>1</code>/<code>0</code>)
|-
| is_videomessage_enabled || integer || Whether video messaging is enabled (<code>1</code>/<code>0</code>)
|-
| 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 (<code>1</code>/<code>0</code>; present when AI is enabled)
|-
| ai_call_summary || integer || AI call summary setting (<code>1</code>/<code>0</code>)
|-
| ai_prompt_edit || integer || AI prompt edit setting (<code>1</code>/<code>0</code>)
|-
| ai_virtual_assistant || integer || AI virtual assistant setting (<code>1</code>/<code>0</code>; when AI enabled)
|}

=== Error Responses ===
{| class="wikitable"
! 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.

← Older revision		Revision as of 12:44, 20 July 2026
Line 1:		Line 1:
−	== Get User Settings Info ==	+	== [[Mobile_API]] »Get User Settings Info ==

	=== Base URL ===		=== Base URL ===

@@ Line 39: / Line 39: @@
 ==== Request Body ====
 None.
 === Successful Response (200) ===

Get User Settings Info - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: /* Get User Settings Info */

Ashley DeBon: Created page with "== Get User Settings Info == === Base URL === https://apimobile.callproof.com === Endpoint === /api/user/{latitude}/{longitude}/setting === Purpose === Retrieves the authen..."