SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceTasks

Returns the task with the specified id.

GET
https://api.awork.com/api/v1/tasks/:taskId
GET
/api/v1/tasks/:taskId
1curl https://api.awork.com/api/v1/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": 1,
8  "plannedDuration": 21600,
9  "id": "123e4567-e89b-12d3-a456-426614174000",
10  "isExternal": true,
11  "createdVia": "string",
12  "isHiddenForConnectUsers": true,
13  "baseType": "private",
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": "string",
32    "icon": "string",
33    "isArchived": true
34  },
35  "assignees": [
36    {
37      "id": "123e4567-e89b-12d3-a456-426614174000",
38      "firstName": "string",
39      "lastName": "string",
40      "hasImage": true,
41      "plannedEffort": 1,
42      "isDistributedPlannedEffort": true,
43      "updatedOn": "2020-02-30T18:52:54.945Z",
44      "isExternal": true,
45      "tags": [
46        {
47          "id": "123e4567-e89b-12d3-a456-426614174000",
48          "name": "Design",
49          "color": "purple"
50        }
51      ],
52      "teams": [
53        {
54          "id": "123e4567-e89b-12d3-a456-426614174000"
55        }
56      ]
57    }
58  ],
59  "projectId": "123e4567-e89b-12d3-a456-426614174000",
60  "project": {
61    "id": "123e4567-e89b-12d3-a456-426614174000",
62    "name": "string",
63    "projectStatus": {
64      "id": "123e4567-e89b-12d3-a456-426614174000",
65      "name": "string",
66      "description": "string",
67      "type": "string",
68      "isArchived": true
69    },
70    "company": {
71      "id": "123e4567-e89b-12d3-a456-426614174000",
72      "name": "string",
73      "hasImage": true,
74      "description": "NCNSTN Brand Design Company",
75      "tags": [
76        {
77          "id": "123e4567-e89b-12d3-a456-426614174000",
78          "name": "Design",
79          "color": "purple"
80        }
81      ]
82    },
83    "companyId": "123e4567-e89b-12d3-a456-426614174000",
84    "projectType": {
85      "id": "123e4567-e89b-12d3-a456-426614174000",
86      "name": "string",
87      "icon": "string",
88      "isArchived": true
89    },
90    "hasImage": true,
91    "isPrivate": true,
92    "isBillableByDefault": true,
93    "members": [
94      {
95        "id": "123e4567-e89b-12d3-a456-426614174000",
96        "userId": "123e4567-e89b-12d3-a456-426614174000",
97        "projectRoleId": "123e4567-e89b-12d3-a456-426614174000",
98        "projectRoleName": "string",
99        "isResponsible": true,
100        "isExternal": true
101      }
102    ],
103    "color": "purple",
104    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
105    "teams": [
106      {
107        "id": "123e4567-e89b-12d3-a456-426614174000"
108      }
109    ],
110    "customFields": [
111      {
112        "customFieldDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
113        "userIdValue": "123e4567-e89b-12d3-a456-426614174000",
114        "numberValue": 123,
115        "selectionOptionIdValue": "123e4567-e89b-12d3-a456-426614174000",
116        "selectionOption": {
117          "value": "Website Design",
118          "order": 0,
119          "id": "123e4567-e89b-12d3-a456-426614174000",
120          "color": "red"
121        },
122        "textValue": "S1: Business Critical",
123        "dateValue": "2024-01-15T09:30:00Z",
124        "booleanValue": true
125      }
126    ],
127    "isExternal": true,
128    "tags": [
129      {
130        "id": "123e4567-e89b-12d3-a456-426614174000",
131        "name": "Design",
132        "color": "purple"
133      }
134    ]
135  },
136  "correlationId": "123e4567-e89b-12d3-a456-426614174000",
137  "parentId": "123e4567-e89b-12d3-a456-426614174000",
138  "parentTask": {
139    "id": "123e4567-e89b-12d3-a456-426614174000",
140    "name": "string",
141    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
142    "userId": "123e4567-e89b-12d3-a456-426614174000",
143    "assigneeIds": [
144      "string"
145    ]
146  },
147  "isSubtask": true,
148  "numberOfSubtasks": 1,
149  "hasAttachment": false,
150  "lists": [
151    {
152      "id": "123e4567-e89b-12d3-a456-426614174000",
153      "createdOn": "2021-03-22T15:00:00Z",
154      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
155      "updatedOn": "2021-03-22T16:30:00Z",
156      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
157      "name": "Product and Marketing To-Dos",
158      "order": 2,
159      "isArchived": false,
160      "isHiddenForConnectUsers": true,
161      "orderOfTask": 5
162    }
163  ],
164  "userId": "123e4567-e89b-12d3-a456-426614174000",
165  "tags": [
166    {
167      "id": "123e4567-e89b-12d3-a456-426614174000",
168      "name": "Design",
169      "color": "purple"
170    }
171  ],
172  "createdOn": "2022-02-29T18:52:54.945Z",
173  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
174  "updatedOn": "2020-02-30T18:52:54.945Z",
175  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
176  "closedOn": "2024-01-15T09:30:00Z",
177  "closedBy": "123e4567-e89b-12d3-a456-426614174000",
178  "order": 2,
179  "subtaskOrder": 1,
180  "createdFromTaskId": "123e4567-e89b-12d3-a456-426614174000",
181  "isRecurring": true,
182  "customFields": [
183    {
184      "customFieldDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
185      "userIdValue": "123e4567-e89b-12d3-a456-426614174000",
186      "numberValue": 123,
187      "selectionOptionIdValue": "123e4567-e89b-12d3-a456-426614174000",
188      "selectionOption": {
189        "value": "Website Design",
190        "order": 0,
191        "id": "123e4567-e89b-12d3-a456-426614174000",
192        "color": "red"
193      },
194      "textValue": "S1: Business Critical",
195      "dateValue": "2024-01-15T09:30:00Z",
196      "booleanValue": true
197    }
198  ],
199  "trackedDuration": 1200,
200  "totalTrackedDuration": 1200,
201  "totalPlannedDuration": 21600,
202  "resourceVersion": 637825154598030700,
203  "checklistItemsDoneCount": 2,
204  "checklistItemsCount": 5,
205  "taskSchedulesCount": 1,
206  "isCompletelyScheduled": true,
207  "commentCount": 1,
208  "entityId": "123e4567-e89b-12d3-a456-426614174000",
209  "remainingDuration": 10500,
210  "totalRemainingDuration": 1
211}
The required permissions depend on the base type of the task. If the task is a project task, 'read' permissions on the 'project-planning-data' feature are required. For a user's private task, no special permissions are required. <Check title="Required Permissions">Any authenticated user.</Check>
Was this page helpful?
Previous

Updates the task with the specified id.

Next
Built with
Updates the task with the specified id.

Authentication

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

Path parameters

taskIdstringRequiredformat: "uuid"
The id of the task.

Response

OK
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.
startOnstring or nullformat: "date-time"
The expected start date and time of the task.
dueOnstring or nullformat: "date-time"
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.
idstring or nullformat: "uuid"
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:
taskStatusIdstring or nullformat: "uuid"
The id of the status for this task.
taskStatusobject or null
typeOfWorkIdstring or nullformat: "uuid"
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.
projectIdstring or nullformat: "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.
projectobject or null
correlationIdstring or nullformat: "uuid"
The correlation id between parent and subtasks, meaning it's either the ParentId or its own Id.
parentIdstring or nullformat: "uuid"
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.
userIdstring or nullformat: "uuid"
The id of the user of the private task.
tagslist of objects or null
The list of tags.
createdOnstring or nullformat: "date-time"
The date this task was created.
createdBystring or nullformat: "uuid"
The id of the user who created this task.
updatedOnstring or nullformat: "date-time"
The date this task was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this task.
closedOnstring or nullformat: "date-time"
The date the task was set to closed.
closedBystring or nullformat: "uuid"
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.
createdFromTaskIdstring or nullformat: "uuid"
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.
entityIdstring or nullformat: "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.
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.
The expected due date and time of the task.
The lane order defines the vertical position in the task board.
The expected planned workload of the task, in seconds.
The Id of the task.
The origin of the task. From which 'flow' the task was created. Automatically set by the backend.
True if the task is hidden for external workspace users. False otherwise.
The base type of the task. Can be 'private' for a private task or 'projecttask' for a project task.
The id of the status for this task.
The id of the type of work of this task.
The list assigned users of this task, or empty if not user was assigned.
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.
The correlation id between parent and subtasks, meaning it's either the ParentId or its own Id.
The id of the parent task this of this subtask. Only set if this is a subtask.
True if the task is a subtask.
The number of subtasks of this task. Null if it's not a parent task.
Whether this task has an attachment.
The lists to which the task is assigned to.
The id of the user of the private task.
The list of tags.
The date this task was created.
The id of the user who created this task.
The date this task was last modified.
The id of the user who last modified this task.
The date the task was set to closed.
The user who closed the task.
The order of the task in a task status column.
The order of the subtask relative to its parent task.
When the task was created by a recurrency rule, the id is the link to the template of which the task was created.
Custom fields of the task.
The summed up duration of all time trackings for this task.
The summed up duration of all time trackings for this task, including subtasks.
The total planned workload of the task, in seconds, including subtasks.
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
The number of checklist items marked as done.
The total number of checklist items.
The number of task schedules for this task.
Whether this task is completed scheduled.
The number of comments on this task.
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.
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.
The total remaining duration from the original planned effort of the task, in seconds, including subtasks.
The id of the task.
OK

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

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

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

The required permissions depend on the base type of the task. If the task is a project task, ‘read’ permissions on the ‘project-planning-data’ feature are required. For a user’s private task, no special permissions are required.

Required Permissions
Any authenticated user.

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

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