Difference between revisions of "Get Task Details For Specific Task Id"

From docs
Jump to: navigation, search
(Created page with "== Get Task Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{contact_id}/task/{task_id} === Purpose === Retrieves the details of a...")
 
(Get Task Details)
Line 1: Line 1:
== Get Task Details ==
+
== [[Mobile_API]] »Get Task Details ==
  
 
=== Base URL ===
 
=== Base URL ===

Revision as of 08:02, 20 July 2026

Mobile_API »Get Task Details

Base URL

https://apimobile.callproof.com

Endpoint

/api/contact/{contact_id}/task/{task_id}

Purpose

Retrieves the details of a specific scheduled task (follow-up) for a contact, including assignment, type, priority, people, calendar options, and recurrence settings. Date and time are returned in the authenticated user’s timezone.

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter Type Required Description
contact_id integer Yes Unique identifier of the contact
task_id integer Yes Unique identifier of the task to retrieve

Query Parameters

None.

Request Body

None.

Successful Response (200)

Returns the task details for the given contact and task ID.

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 Task detail payload
uri string Requested resource URI

data

Field Type Description
task_id integer Unique identifier of the task
task_duration number Task duration in minutes
task_notes string Task notes
task_completed mixed Completion status/timestamp of the task
task_send_office_cal boolean/integer Whether the task is sent to Office calendar
task_send_google_cal boolean/integer Whether the task is sent to Google Calendar
task_type_id integer Task type identifier
task_type_name string Task type display name
task_assignment_id integer User ID of the assignee
task_assignment_name string Full name of the assignee
task_date string Task date in the user’s timezone (format: m-d-Y)
task_time string Task time in the user’s timezone (format: g:i A)
task_people array People linked to the task (see below)
task_priority_id integer Task priority identifier
task_priority_name string Task priority display name
recurrence_id integer Recurrence/calendar event identifier (0 when none)
recurrence_type string/integer Recurrence type
repeat_interval integer Repeat interval
repeat_day string Days of week for recurrence
repeat_count integer Number of occurrences
end_date_daily string Recurrence end date (daily)
end_date_weekly string Recurrence end date (weekly)
end_date_monthly string Recurrence end date (monthly)
end_date_year string Recurrence end date (yearly)
assign_month_date integer Day of month for monthly recurrence
assign_year_date integer Day of month for yearly recurrence
assign_year_day string Days of week for yearly recurrence
assign_year_month integer Month for yearly recurrence
index string Recurrence index value

data.task_people[]

Field Type Description
people_id integer Unique identifier of the linked person
people_name string Full name of the linked person

Error Responses

Status Code Meaning
400 Bad Request – task details could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while retrieving the task (for example, "Error while retiving the Task details").
  • 401 – Authentication failed or the access token is missing/expired.