namestring required
The name of the task. Max allowed length: 1000 characters.
descriptionstring nullable
The description of the task. Max allowed length: 25000 characters.
isPrioboolean
Whether this task is marked as priority.
startOnstring date-time nullable
The expected start date and time of the task.
dueOnstring date-time nullable
The expected due date and time of the task.
laneOrderinteger
The lane order defines the vertical position in the task board.
plannedDurationinteger
The expected planned workload of the task, in seconds.
taskNumberinteger nullable
The sequential task number within the project.
Unique within the project, never reused even after deletion.
taskIdentifierstring nullable
The full task identifier combining project key and task number (e.g., "NIKE-42").
Maintained by the service layer, updated when project key changes.
isExternalboolean
True if the model is coming from an external workspace (awork Connect).
False otherwise.
createdViastring nullable
The origin of the task. From which 'flow' the task was created.
Automatically set by the backend.
isHiddenForConnectUsersboolean
True if the task is hidden for external workspace users.
False otherwise.
baseType'private' | 'projecttask'
The base type of the task.
Can be 'private' for a private task or
'projecttask' for a project task.
taskStatusIdstring uuid
The id of the status for this task.
typeOfWorkIdstring uuid
The id of the type of work of this task.
projectIdstring uuid nullable
The id of the project this task is assigned to.
Only set if this is a project task.
In this case, it is equal to the EntityId.
correlationIdstring uuid
The correlation id between parent and subtasks, meaning it's either the ParentId or its own Id.
parentIdstring uuid nullable
The id of the parent task this of this subtask.
Only set if this is a subtask.
isSubtaskboolean
True if the task is a subtask.
numberOfSubtasksinteger nullable
The number of subtasks of this task.
Null if it's not a parent task.
hasAttachmentboolean
Whether this task has an attachment.
entityIdstring uuid nullable
The id of the entity this task is assigned to.
This is the id of the project if this is a project task,
or the id of a user if this is a private task.
See 'BaseType' for supported types.
userIdstring uuid nullable
The id of the user of the private task.
createdOnstring date-time
The date this task was created.
createdBystring uuid
The id of the user who created this task.
updatedOnstring date-time
The date this task was last modified.
updatedBystring uuid
The id of the user who last modified this task.
closedOnstring date-time nullable
The date the task was set to closed.
closedBystring uuid nullable
The user who closed the task.
ordernumber double
The order of the task in a task status column.
subtaskOrdernumber double nullable
The order of the subtask relative to its parent task.
createdFromTaskIdstring uuid nullable
When the task was created by a recurrency rule, the id is the link to the template of which the task was created.
isRecurringboolean
If the task is a recurrency template (used to create new tasks by a recurrency rule), the flag is true.
trackedDurationinteger nullable
The summed up duration of all time trackings directly on this task (excluding subtasks).
totalTrackedDurationinteger nullable
The summed up duration of all time trackings for this task, including subtasks.
totalPlannedDurationinteger nullable
The total planned workload of the task, in seconds, including subtasks.
resourceVersioninteger
The version of the entity, updated on every modification, to the ticks in UTC.
Not identical to UpdatedOn.
checklistItemsDoneCountinteger
The number of checklist items marked as done.
checklistItemsCountinteger
The total number of checklist items.
taskSchedulesCountinteger
The number of task schedules for this task.
isCompletelyScheduledboolean
Whether this task is completed scheduled.
commentCountinteger
The number of comments on this task.