API v1 ReferenceTask Lists

Returns the task with the specified id in the task list with the specified id.

To get a task in a project task list, the user needs read permissions on the project-planning-data feature. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequiredformat: "uuid"
The id of the project.
taskListIdstringRequiredformat: "uuid"
The id of the task list.
taskIdstringRequiredformat: "uuid"
The id of the task.

Response

OK
namestring0-1000 characters

The name of the task. Max allowed length: 1000 characters.

descriptionstring or nullOptional0-25000 characters

The description of the task. Max allowed length: 25000 characters.

isPriobooleanOptional
Whether this task is marked as priority.
startOnstring or nullOptionalformat: "date-time"
The expected start date and time of the task.
dueOnstring or nullOptionalformat: "date-time"
The expected due date and time of the task.
laneOrderintegerOptional
The lane order defines the vertical position in the task board.
plannedDurationintegerOptional
The expected planned workload of the task, in seconds.
idstringOptionalformat: "uuid"
The Id of the task.
taskNumberinteger or nullOptional
The sequential task number within the project. Unique within the project, never reused even after deletion.
taskIdentifierstring or nullOptional<=40 characters

The full task identifier combining project key and task number (e.g., “NIKE-42”). Maintained by the service layer, updated when project key changes.

isExternalbooleanOptional

True if the model is coming from an external workspace (awork Connect). False otherwise.

createdViastring or nullOptional
The origin of the task. From which 'flow' the task was created. Automatically set by the backend.
isHiddenForConnectUsersbooleanOptional
True if the task is hidden for external workspace users. False otherwise.
baseTypeenumOptional
The base type of the task. Can be 'private' for a private task or 'projecttask' for a project task.
taskStatusIdstringOptionalformat: "uuid"
The id of the status for this task.
taskStatusobjectOptional
typeOfWorkIdstringOptionalformat: "uuid"
The id of the type of work of this task.
typeOfWorkobjectOptional
assigneeslist of objects or nullOptional
The list assigned users of this task, or empty if not user was assigned.
projectIdstring or nullOptionalformat: "uuid"
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.
projectobjectOptional
correlationIdstringOptionalformat: "uuid"
The correlation id between parent and subtasks, meaning it's either the ParentId or its own Id.
parentIdstring or nullOptionalformat: "uuid"
The id of the parent task this of this subtask. Only set if this is a subtask.
parentTaskobjectOptional
isSubtaskbooleanOptionalRead-only
True if the task is a subtask.
numberOfSubtasksinteger or nullOptional
The number of subtasks of this task. Null if it's not a parent task.
hasAttachmentbooleanOptional
Whether this task has an attachment.
listslist of objects or nullOptional
The lists to which the task is assigned to.
userIdstring or nullOptionalformat: "uuid"
The id of the user of the private task.
tagslist of objects or nullOptional
The list of tags.
createdOnstringOptionalformat: "date-time"
The date this task was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this task.
updatedOnstringOptionalformat: "date-time"
The date this task was last modified.
updatedBystringOptionalformat: "uuid"
The id of the user who last modified this task.
closedOnstring or nullOptionalformat: "date-time"
The date the task was set to closed.
closedBystring or nullOptionalformat: "uuid"
The user who closed the task.
orderdoubleOptional
The order of the task in a task status column.
subtaskOrderdouble or nullOptional
The order of the subtask relative to its parent task.
createdFromTaskIdstring or nullOptionalformat: "uuid"
When the task was created by a recurrency rule, the id is the link to the template of which the task was created.
isRecurringbooleanOptional

If the task is a recurrency template (used to create new tasks by a recurrency rule), the flag is true.

customFieldslist of objects or nullOptional
Custom fields of the task.
trackedDurationinteger or nullOptional

The summed up duration of all time trackings directly on this task (excluding subtasks).

totalTrackedDurationinteger or nullOptional
The summed up duration of all time trackings for this task, including subtasks.
totalPlannedDurationinteger or nullOptional
The total planned workload of the task, in seconds, including subtasks.
resourceVersionlongOptionalRead-only
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
checklistItemsDoneCountintegerOptional
The number of checklist items marked as done.
checklistItemsCountintegerOptional
The total number of checklist items.
taskSchedulesCountintegerOptional
The number of task schedules for this task.
isCompletelyScheduledbooleanOptional
Whether this task is completed scheduled.
commentCountintegerOptional
The number of comments on this task.
entityIdstring or nullOptionalformat: "uuid"Deprecated
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.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error