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

GET

https://api.awork.com/api/v1/projects/:projectId/tasklists/:taskListId/tasks/:taskId

GET

/api/v1/projects/:projectId/tasklists/:taskListId/tasks/:taskId

1 curl https://api.awork.com/api/v1/projects/projectId/tasklists/taskListId/tasks/taskId \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "name": "Create logo concept",
3   "description": "We need to create a new impactful concept for the customer logo",
4   "isPrio": true,
5   "startOn": "2023-03-03T17:00:00Z",
6   "dueOn": "2023-03-18T17:00:00Z",
7   "laneOrder": 0,
8   "plannedDuration": 21600,
9   "id": "123e4567-e89b-12d3-a456-426614174000",
10   "isExternal": false,
11   "isHiddenForConnectUsers": false,
12   "baseType": "projecttask",
13   "taskStatusId": "123e4567-e89b-12d3-a456-426614174000",
14   "taskStatus": {
15     "id": "123e4567-e89b-12d3-a456-426614174000",
16     "name": "Conceptualize",
17     "type": "progress",
18     "order": 2,
19     "icon": "arrow_forward",
20     "projectId": "123e4567-e89b-12d3-a456-426614174000",
21     "projectTypeId": "123e4567-e89b-12d3-a456-426614174000",
22     "createdOn": "2022-03-{10}T15:51:58.100Z",
23     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
24     "updatedOn": "2022-03-10T16:15:26.100Z",
25     "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
26   },
27   "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
28   "typeOfWork": {
29     "id": "123e4567-e89b-12d3-a456-426614174000",
30     "name": null,
31     "icon": null,
32     "isArchived": false
33   },
34   "assignees": [
35     {
36       "id": "123e4567-e89b-12d3-a456-426614174000",
37       "firstName": null,
38       "lastName": null,
39       "hasImage": null,
40       "plannedEffort": 0,
41       "isDistributedPlannedEffort": false,
42       "updatedOn": "2020-02-30T18:52:54.945Z",
43       "isExternal": false
44     }
45   ],
46   "projectId": "123e4567-e89b-12d3-a456-426614174000",
47   "project": {
48     "id": "123e4567-e89b-12d3-a456-426614174000",
49     "name": null,
50     "projectStatus": {
51       "id": "123e4567-e89b-12d3-a456-426614174000",
52       "name": null,
53       "description": null,
54       "type": null,
55       "isArchived": false
56     },
57     "company": {
58       "id": "123e4567-e89b-12d3-a456-426614174000",
59       "name": null,
60       "hasImage": true,
61       "description": "NCNSTN Brand Design Company"
62     },
63     "companyId": "123e4567-e89b-12d3-a456-426614174000",
64     "projectType": {
65       "id": "123e4567-e89b-12d3-a456-426614174000",
66       "name": null,
67       "icon": null,
68       "isArchived": false
69     },
70     "hasImage": true,
71     "isPrivate": false,
72     "isBillableByDefault": null,
73     "members": [
74       {
75         "id": "123e4567-e89b-12d3-a456-426614174000",
76         "userId": "123e4567-e89b-12d3-a456-426614174000",
77         "projectRoleId": "123e4567-e89b-12d3-a456-426614174000",
78         "projectRoleName": null,
79         "isResponsible": false,
80         "isExternal": false
81       }
82     ],
83     "color": "purple",
84     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
85     "teams": [
86       {
87         "id": "123e4567-e89b-12d3-a456-426614174000"
88       }
89     ],
90     "isExternal": false
91   },
92   "correlationId": "123e4567-e89b-12d3-a456-426614174000",
93   "parentId": "123e4567-e89b-12d3-a456-426614174000",
94   "parentTask": {
95     "id": "123e4567-e89b-12d3-a456-426614174000",
96     "name": null,
97     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
98     "userId": "123e4567-e89b-12d3-a456-426614174000",
99     "assigneeIds": [
100       "assigneeIds"
101     ]
102   },
103   "isSubtask": false,
104   "numberOfSubtasks": null,
105   "hasAttachment": false,
106   "lists": [
107     {
108       "id": "123e4567-e89b-12d3-a456-426614174000",
109       "isArchived": false,
110       "createdOn": "2021-03-22T15:00:00Z",
111       "createdBy": "123e4567-e89b-12d3-a456-426614174000",
112       "updatedOn": "2021-03-22T16:30:00Z",
113       "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
114       "name": "Product and Marketing To-Dos",
115       "order": 2,
116       "isHiddenForConnectUsers": false,
117       "orderOfTask": 5
118     }
119   ],
120   "userId": "123e4567-e89b-12d3-a456-426614174000",
121   "tags": [
122     {
123       "id": "123e4567-e89b-12d3-a456-426614174000",
124       "name": "Design",
125       "color": "purple"
126     }
127   ],
128   "createdOn": "2022-02-29T18:52:54.945Z",
129   "createdBy": "123e4567-e89b-12d3-a456-426614174000",
130   "updatedOn": "2020-02-30T18:52:54.945Z",
131   "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
132   "closedOn": null,
133   "closedBy": "123e4567-e89b-12d3-a456-426614174000",
134   "order": 2,
135   "subtaskOrder": 1,
136   "createdFromTaskId": "123e4567-e89b-12d3-a456-426614174000",
137   "isRecurring": false,
138   "customFields": [
139     {
140       "customFieldDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
141       "userIdValue": "123e4567-e89b-12d3-a456-426614174000",
142       "numberValue": 123.45,
143       "selectionOptionIdValue": "123e4567-e89b-12d3-a456-426614174000",
144       "selectionOption": {
145         "id": "123e4567-e89b-12d3-a456-426614174000",
146         "value": "Website Design",
147         "color": "purple",
148         "order": 0
149       },
150       "textValue": "S1: Business Critical",
151       "dateValue": null,
152       "booleanValue": true
153     }
154   ],
155   "trackedDuration": 1200,
156   "totalTrackedDuration": 1200,
157   "totalPlannedDuration": 21600,
158   "remainingDuration": 10500,
159   "totalRemainingDuration": null,
160   "resourceVersion": 637825154598030700,
161   "checklistItemsDoneCount": 2,
162   "checklistItemsCount": 5,
163   "taskSchedulesCount": 1,
164   "isCompletelyScheduled": false,
165   "commentCount": 0
166 }

To get a project task from the project task list, the user needs read permissions on the project-planning-data feature or the current user must be assigned to the task with the specified id. For a private task list no permissions are required.

Path parameters

projectIdUUIDRequired

The id of the project.

taskListIdUUIDRequired

The id of the task list.

taskIdUUIDRequired

The id of the task.

Response

namestring>=0 characters<=1000 characters

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

descriptionstring or nullOptional>=0 characters<=25000 characters

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

isPriobooleanOptional

Whether this task is marked as priority.

startOndatetime or nullOptional

The expected start date and time of the task.

dueOndatetime or nullOptional

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.

idUUIDOptional

The Id of the task.

isExternalbooleanOptional

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

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.

Allowed values:

taskStatusIdUUIDOptional

The id of the status for this task.

taskStatusobjectOptional

typeOfWorkIdUUIDOptional

The id of the type of work of this task.

typeOfWorkobjectOptional

assigneeslist of objectsOptional

The list assigned users of this task, or empty if not user was assigned.

projectIdUUID or nullOptional

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

correlationIdUUIDOptional

The correlation id between parent and subtasks, meaning it's either the ParentId or its own Id.

parentIdUUID or nullOptional

The id of the parent task this of this subtask. Only set if this is a subtask.

parentTaskobjectOptional

isSubtaskbooleanOptional

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 objectsOptional

The lists to which the task is assigned to.

userIdUUID or nullOptional

The id of the user of the private task.

tagslist of objectsOptional

The list of tags.

createdOndatetimeOptional

The date this task was created.

createdByUUIDOptional

The id of the user who created this task.

updatedOndatetimeOptional

The date this task was last modified.

updatedByUUIDOptional

The id of the user who last modified this task.

closedOndatetime or nullOptional

The date the task was set to closed.

closedByUUID or nullOptional

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.

createdFromTaskIdUUID or nullOptional

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 objectsOptional

Custom fields of the task.

trackedDurationinteger or nullOptional

The summed up duration of all time trackings for this task.

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.

remainingDurationinteger or nullOptional

The expected remaining duration from the original planned effort of the task, in seconds. Null if the user has no permissions to see time tracking information.

totalRemainingDurationinteger or nullOptional

The total remaining duration from the original planned effort of the task, in seconds, including subtasks.

resourceVersionlongOptional

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.

entityIdUUID or nullOptionalDeprecated

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.

Path parameters

Headers

Response