API Reference - Tasks

Tasks within Trackops are not required to be connected to a case or a subject.

Listing Tasks

Returns a collection of task records, optionally filtered by the available request parameters.

GET /api/v1/tasks

 

Available Request Parameters:

Name Type Required Description
id integer no ID of the task.
title string no Title/name of the task.
calendar integer no ID of the calendar the event is assigned to.
case integer no ID of the case connected to this task.
subject integer no ID of the subject associated with this task.
status string no Choices: "none", "needs_action", "in_progress", "complete"

(see explanation of statuses below)
due_from date no Task is due on or after the date (Alias: From).
due_to date no Task is due on or before the date (Alias: To).
complete_from timestamp no Task was completed on or after the date.
complete_to timestamp no Task was completed on or before the date.
alert_from timestamp no Event alert is scheduled on or after the date.
alert_to timestamp no Event alert is scheduled on or before the date.
alert_sent_from timestamp no Event alert was delivered on or after the date.
alert_sent_to timestamp no Event alert was delivered on or before the date.
created_from timestamp no Created on or after the date, as determined by the system.
created_to timestamp no Created on or before the date, as determined by the system.
updated_from timestamp no Updated on or after the date, as determined by the system.
updated_to timestamp no Updated on or before the date, as determined by the system.

Note: All timestamp parameters are queried and returned in UTC.

Explanation of Statuses

  • none - There is no status defined (this is the default status).
  • needs_action - The task requires action to be taken.
  • in_progress - Work on this task is currently being performed.
  • complete - The task has been completed.

Getting a Task

Returns a single task record, based on the numeric ID.

GET /api/v1/tasks/{task_id}

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request