Ashley DeBon: Created page with "== Get Dashboard Widgets == === Base URL === https://apimobile.callproof.com === Endpoint === /api/v1/widgets === Purpose === Returns the authenticated user's dashboard wid..."

2026-07-15T11:14:27Z

Created page with "== Get Dashboard Widgets == === Base URL === https://apimobile.callproof.com === Endpoint === /api/v1/widgets === Purpose === Returns the authenticated user's dashboard wid..."

New page

== Get Dashboard Widgets ==

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

=== Endpoint ===
/api/v1/widgets

=== Purpose ===
Returns the authenticated user's dashboard widget preferences.

The response identifies enabled widgets, disabled widgets available for selection, their display positions, and the current status of the Recommended Follow Up and Tasks widgets.

The Tasks and Opportunity widgets may be enabled automatically when the user has relevant business activity associated with those widgets.

=== HTTP Method ===
GET

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

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.
* The access token must be active and unexpired.
* The authenticated user and associated company account must be active.
* If two-factor authentication is enabled, verification must be completed for the registered device.

=== Parameters ===
This endpoint does not accept path, query, or request body parameters.

=== Successful Response (200) ===
Returns the authenticated user's current widget configuration and display order.

==== Top-Level Response Fields ====
{| class="wikitable"
! Response Field !! Type !! Description
|-
| clientStatusCode || integer || Business-level response status. A successful request returns <code>200</code>.
|-
| user_id || integer || The authenticated user's unique identifier.
|-
| company_id || integer || The company associated with the authenticated user.
|-
| data || object || Contains widget statuses and ordered widget collections.
|-
| uri || string || The URL of the request.
|}

==== Widget Configuration Fields ====
{| class="wikitable"
! Response Field !! Type !! Description
|-
| data.recommended_followup || integer || Status of the Recommended Follow Up widget. <code>1</code> indicates enabled and <code>0</code> indicates disabled.
|-
| data.task_widget || integer || Status of the Tasks widget. <code>1</code> indicates enabled and <code>0</code> indicates disabled.
|-
| data.widgets || array || Widgets currently enabled for the user, arranged in display order.
|-
| data.widgets_available || array || Disabled widgets currently available for the user to enable.
|}

==== Widget Entry Fields ====
Each entry in <code>data.widgets</code> and <code>data.widgets_available</code> contains:

{| class="wikitable"
! Response Field !! Type !! Description
|-
| name || string || The business-friendly widget name.
|-
| id || integer || The widget type's unique identifier.
|-
| position || integer || The widget's display position. Lower values appear earlier.
|}

Possible widgets include:

* Recent Events
* Appointments
* Emails
* Calls
* Tasks
* Opportunity
* Business Card
* Business Card Image
* Recommended Follow Up

Some widgets are managed through dedicated status fields and may not appear in the general <code>widgets</code> or <code>widgets_available</code> collections.

=== Error Responses ===
{| class="wikitable"
! HTTP Status Code !! Client Status Code !! Meaning
|-
| 200 || 401 || No widget configuration is available for the authenticated user.
|-
| 200 || 401 || Two-factor authentication is required but has not been completed for the registered device.
|-
| 401 || 401 || The Bearer token is missing or invalid.
|-
| 401 || 401 || The access token has expired.
|-
| 401 || 401 || The authenticated user or company account is disabled.
|-
| 401 || 401 || A required client application update must be installed.
|}

==== Error Response Fields ====
{| class="wikitable"
! Response Field !! Type !! Description
|-
| clientStatusCode || integer || The business-level error status.
|-
| error.code || integer || The business error code.
|-
| error.message || string || A plain-language explanation of the request failure.
|-
| uri || string || The URL of the request.
|}

==== Common Error Codes ====
{| class="wikitable"
! Error Code !! Meaning
|-
| 1500 || Authentication, authorization, widget availability, or two-factor verification failed.
|-
| 1800 || The user or company account is disabled.
|-
| 8000 || The access token has expired.
|-
| 9000 || A required client application update is available.
|}

Dashboard Widgets Get Details - Revision history

Ashley DeBon: Created page with "== Get Dashboard Widgets == === Base URL === https://apimobile.callproof.com === Endpoint === /api/v1/widgets === Purpose === Returns the authenticated user's dashboard wid..."