Difference between revisions of "Get company Settings-info"
Ashley DeBon (talk | contribs) (Created page with "== Get Company Settings == === Base URL === https://apimobile.callproof.com === Endpoint === /api/company-settings === Purpose === Retrieves company-level feature settings...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Get Company Settings == | + | == [[Mobile_API]] »Get Company 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/company-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/company-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 12:49, 20 July 2026
Contents
Mobile_API »Get Company Settings
Base URL
https://apimobile.callproof.com
Endpoint
/api/company-settings
Purpose
Retrieves company-level feature settings for the authenticated user’s company, including recommended follow-up, task widget, and opportunity widget enablement flags.
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/company-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/company-settings' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns the company feature 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 | Company settings payload |
| uri | string | Requested resource URI |
data.company_settings
| Field | Type | Description |
|---|---|---|
| is_recommended_followup_enabled | boolean | Whether recommended follow-ups are enabled for the company |
| is_task_widget_enabled | boolean | Whether the task widget is enabled for the company |
| is_opportunity_widget_enabled | boolean | Whether the opportunity widget is enabled for the company |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – company settings could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while loading company settings.
- 401 – Authentication failed or the access token is missing/expired.
