Ashley DeBon: /* Get App Settings */

2026-07-24T07:18:16Z

‎Get App Settings

Ashley DeBon: Created page with "== Get App Settings == === Base URL === https://apimobile.callproof.com === Endpoint === /api/app-settings === Purpose === Retrieves the authenticated user’s mobile app p..."

2026-07-24T07:18:03Z

Created page with "== Get App Settings == === Base URL === https://apimobile.callproof.com === Endpoint === /api/app-settings === Purpose === Retrieves the authenticated user’s mobile app p..."

New page

== Get App Settings ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/app-settings

=== Purpose ===
Retrieves the authenticated user’s mobile app preference settings, including calendar sync, appointment/task popup preferences, homepage preference, logging, start-appointment flag, and task notification timing choices.

=== HTTP Method ===
GET

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

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

=== Parameters ===

==== Path Parameters ====
None.

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

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

=== Successful Response (200) ===
Returns the user’s current app settings.

{| 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 || App settings payload
|-
| uri || string || Requested resource URI
|}

==== data ====
{| class="wikitable"
! Field !! Type !! Description
|-
| google_cal_sync || boolean || Whether device calendar sync is enabled
|-
| hide_appt_popup || boolean || Whether the mobile appointment popup is hidden
|-
| task_popup_setting || boolean || Whether the task popup is enabled for display
|-
| is_contact_page_as_homepage || boolean || Whether the contacts page is set as the app homepage
|-
| is_logs_enabled || boolean || Whether company logging is enabled
|-
| is_start_appointment || boolean || Whether start-appointment behavior is enabled for the user
|-
| device_notification || object || Contains the list of task notification timing choices
|}

==== data.device_notification.choices[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| task_notification_choice_id || integer || Unique identifier of the notification timing choice
|-
| name || string || Display name of the choice
|-
| value || mixed || Timing value for the choice
|-
| selected || boolean || Whether this choice is currently selected for the user
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 400 || Bad Request – app settings could not be retrieved
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

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

← Older revision		Revision as of 07:18, 24 July 2026
Line 1:		Line 1:
−	== Get App Settings ==	+	==[[Mobile_API]] » Get App Settings ==

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

SAML Metadata - Revision history

Ashley DeBon: /* Get App Settings */

Ashley DeBon: Created page with "== Get App Settings == === Base URL === https://apimobile.callproof.com === Endpoint === /api/app-settings === Purpose === Retrieves the authenticated user’s mobile app p..."