Returns the project task with the specified id.

GET

https://api.awork.com/api/v1/projects/:projectId/projecttasks/:taskId

GET

/api/v1/projects/:projectId/projecttasks/:taskId

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

To get the task with the specified id ‘read’ permissions on the feature project-planning-data are necessary. But the assignee has also the permissions to get the task.

Required Permissions

Any authenticated user.

Path parameters

projectIdUUIDRequired

The id of the project.

taskIdUUIDRequired

The id of the task.

Response

namestring>=0 characters<=1000 characters

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

descriptionstring or null>=0 characters<=25000 characters

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

isPrioboolean or null

Whether this task is marked as priority.

startOndatetime or null

The expected start date and time of the task.

dueOndatetime or null

The expected due date and time of the task.

laneOrderinteger or null

The lane order defines the vertical position in the task board.

plannedDurationinteger or null

The expected planned workload of the task, in seconds.

idUUID or null

The Id of the task.

isExternalboolean or null

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

createdViastring or null

The origin of the task. From which 'flow' the task was created. Automatically set by the backend.

isHiddenForConnectUsersboolean or null

True if the task is hidden for external workspace users. False otherwise.

baseTypeenum or null

The base type of the task. Can be 'private' for a private task or 'projecttask' for a project task.

Allowed values:

taskStatusIdUUID or null

The id of the status for this task.

taskStatusobject or null

typeOfWorkIdUUID or null

The id of the type of work of this task.

typeOfWorkobject or null

assigneeslist of objects or null

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

projectIdUUID or null

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.

projectobject or null

correlationIdUUID or null

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

parentIdUUID or null

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

parentTaskobject or null

isSubtaskboolean or null

True if the task is a subtask.

numberOfSubtasksinteger or null

The number of subtasks of this task. Null if it's not a parent task.

hasAttachmentboolean or null

Whether this task has an attachment.

listslist of objects or null

The lists to which the task is assigned to.

userIdUUID or null

The id of the user of the private task.

tagslist of objects or null

The list of tags.

createdOndatetime or null

The date this task was created.

createdByUUID or null

The id of the user who created this task.

updatedOndatetime or null

The date this task was last modified.

updatedByUUID or null

The id of the user who last modified this task.

closedOndatetime or null

The date the task was set to closed.

closedByUUID or null

The user who closed the task.

orderdouble or null

The order of the task in a task status column.

subtaskOrderdouble or null

The order of the subtask relative to its parent task.

createdFromTaskIdUUID or null

When the task was created by a recurrency rule, the id is the link to the template of which the task was created.

isRecurringboolean or null

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

customFieldslist of objects or null

Custom fields of the task.

trackedDurationinteger or null

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

totalTrackedDurationinteger or null

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

totalPlannedDurationinteger or null

The total planned workload of the task, in seconds, including subtasks.

resourceVersionlong or null

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

checklistItemsDoneCountinteger or null

The number of checklist items marked as done.

checklistItemsCountinteger or null

The total number of checklist items.

taskSchedulesCountinteger or null

The number of task schedules for this task.

isCompletelyScheduledboolean or null

Whether this task is completed scheduled.

commentCountinteger or null

The number of comments on this task.

entityIdUUID or nullDeprecated

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.

remainingDurationinteger or nullDeprecated

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 nullDeprecated

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

Required Permissions

Path parameters

Headers

Response