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

2026-07-20T08:17:49Z

‎Successful Response (200)

Ashley DeBon: /* Get Current Tasks */

2026-07-20T08:16:51Z

‎Get Current Tasks

Ashley DeBon: Created page with "== Get Current Tasks == === Base URL === https://apimobile.callproof.com === Endpoint === /api/current-tasks/{task_widget} `task_widget` is optional: `/api/current-tasks`..."

2026-07-20T08:16:27Z

Created page with "== Get Current Tasks == === Base URL === https://apimobile.callproof.com === Endpoint === /api/current-tasks/{task_widget} `task_widget` is optional: `/api/current-tasks`..."

New page

== Get Current Tasks ==

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

=== Endpoint ===
/api/current-tasks/{task_widget}

`task_widget` is optional: `/api/current-tasks`

=== Purpose ===
Retrieves the authenticated user’s current (incomplete) tasks for today in the user’s timezone. Task list details are returned when the user’s task popup is enabled, or when this endpoint is called in task-widget mode (`task_widget = 1`).

=== 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
|-
| task_widget || integer || No || Set to <code>1</code> to force returning current task details for the task widget. Defaults to <code>0</code> when omitted
|}

==== Query Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| task_widget || integer || No || Same as the path parameter; used if provided on the request
|}

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

=== Successful Response (200) ===
Returns whether the task popup should be shown, and today’s current tasks when applicable.

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

==== data ====
{| class="wikitable"
! Field !! Type !! Description
|-
| isShowTaskPopup || boolean || Whether the task popup is enabled for the user
|-
| current-task || array || List of current tasks (empty when popup is disabled and <code>task_widget</code> is not <code>1</code>)
|}

==== data.current-task[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| task_id || integer || Unique identifier of the task/follow-up
|-
| task_date || string || Task date in the user’s timezone (format: <code>m-d-Y</code>)
|-
| task_time || string || Task time in the user’s timezone (format: <code>g:i A</code>)
|-
| task_duration || number || Task duration in minutes
|-
| task_notes || string || Task notes
|-
| task_completed || boolean/mixed || Completion status of the task
|-
| contact_id || integer || Related contact identifier
|-
| contact_name || string || Related contact/company name
|-
| task_type_id || integer || Task type identifier
|-
| task_type_name || string || Task type display name
|-
| task_assignment_id || integer || Assigned user identifier
|-
| task_assignment_name || string || Assigned user’s full name
|-
| latitude || number/string || Contact latitude
|-
| longitude || number/string || Contact longitude
|-
| task_people || string || Related person name when personnel is linked; otherwise empty
|}

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

* '''400''' – An error occurred while retrieving current tasks.
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 08:16, 20 July 2026
Line 1:		Line 1:
−	== Get Current Tasks ==	+	== [[Mobile_API]] »Get Current Tasks ==

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

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

Current Tasks - Revision history

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

Ashley DeBon: /* Get Current Tasks */

Ashley DeBon: Created page with "== Get Current Tasks == === Base URL === https://apimobile.callproof.com === Endpoint === /api/current-tasks/{task_widget} `task_widget` is optional: `/api/current-tasks`..."