Sign in

v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Tasks

View task

Find a single task by ID.

get/v1/Tasks/{id}

Path parameters

idinteger required

Format - int32. ID of the task to view.

Response

OK

okboolean
task_idinteger

Primary identifier for this task.

subjectstring

Brief explanation of what is to be done.

messagestring

Detailed explanation of what is to be done.

completeboolean

Indicates task has been completed.

canceledboolean

Indicates task has been canceled.

assigned_tointeger

Foreign identifier indicating a user to which this task is assigned.

group_assigned_tointeger

Foreign identifier indicating a group of users to which this task is assigned.

task_type_idinteger

Foreign identifier indicating the kind of task this is.

customer_idinteger

Foreign identifier indicating association with an account.

request_idinteger

Foreign identifier indicating association with a request.

order_idinteger

Foreign identifier indicating association with an order.

task_step_idinteger

Foreign identifier indicating association with a task step.

due_datestring date-time

Date and time this task is due.

due_date_type'SINGLE' | 'RECURRING_DAY' | 'RECURRING_DATE' | 'RECURRING_DAYOFWEEK' | 'RECURRING_DAILY' | 'RECURRING_HOURLY'

The type of due date or the recurring event. RECURRING_HOURLY - Hourly, RECURRING_DAILY - Daily, RECURRING_DAYOFWEEK - Weekly, RECURRING_DATE - Yearly, RECURRING_DAY - Monthly

remindme_incrementinteger

The interval in which reminder is set to be sent.

remindme_unit'Min' | 'Hr'

The measure or unit in which the reminder is set to be sent.

created_datestring date-time

Date and time this task was created.

created_byinteger

Foreign identifier indicating the user that created this task.