Difference between revisions of "Settings Details"
Ashley DeBon (talk | contribs) (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...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Get App Settings == | + | == [[Mobile_API]] »Get App Settings == |
=== Base URL === | === Base URL === | ||
| Line 33: | Line 33: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/app-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/app-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 12:32, 20 July 2026
Contents
Mobile_API »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
| 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/app-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/app-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns the user’s current app settings.
| 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
| 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 (true means popup is shown)
|
| 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 | Task notification timing options |
data.device_notification.choices[]
| Field | Type | Description |
|---|---|---|
| task_notification_choice_id | integer | Unique identifier of the notification timing choice |
| name | string | Display name of the choice |
| value | integer/string | Timing value for the choice |
| selected | boolean | true when this is the user’s currently selected timing option
|
Error Responses
| 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.
