Returns the task bundle with the specified id.

GET

1 curl https://api.awork.com/api/v1/taskbundles/taskBundleId \
2      -H "Authorization: Bearer <token>"

Play

200Retrieved

1 {
2   "name": "Project Kickoff",
3   "description": "Includes all tasks related to getting this project off the ground successfully. For the joy of work!",
4   "icon": "arrow_forward",
5   "projectTemplateId": "f76a7b32-f279-ec11-94f6-dc984040d6c9",
6   "id": "123e4567-e89b-12d3-a456-426614174000",
7   "createdOn": "2022-03-11T17:53:46.100Z",
8   "createdBy": "123e4567-e89b-12d3-a456-426614174000",
9   "updatedOn": "2022-03-13T11:20:00.100Z",
10   "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
11   "taskLists": [
12     {
13       "id": "123e4567-e89b-12d3-a456-426614174000",
14       "name": "Concept Desing",
15       "orderOfTask": 2,
16       "order": 1,
17       "isHiddenForConnectUsers": false
18     }
19   ],
20   "tasks": [
21     {
22       "name": "Wireframe layout",
23       "description": "Create the wireframe layout ready to be discussed with the stakeholders",
24       "isPrio": false,
25       "plannedDuration": 1400,
26       "relativeStartOn": null,
27       "relativeDueOn": null,
28       "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
29       "assignedRoleId": "123e4567-e89b-12d3-a456-426614174000",
30       "parentId": "123e4567-e89b-12d3-a456-426614174000",
31       "subtaskOrder": 1,
32       "id": "123e4567-e89b-12d3-a456-426614174000",
33       "taskType": {
34         "id": "123e4567-e89b-12d3-a456-426614174000",
35         "name": "Sales Work",
36         "description": "Tasks related to sales dept.",
37         "icon": "attach_money",
38         "isArchived": false,
39         "createdOn": "2022-03-10T16:25:09.100Z",
40         "createdBy": "123e4567-e89b-12d3-a456-426614174000",
41         "updatedOn": "2022-03-10T18:55:00.500Z",
42         "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
43       },
44       "taskListTemplate": [
45         {
46           "id": "123e4567-e89b-12d3-a456-426614174000",
47           "name": "Concept Desing",
48           "orderOfTask": 2,
49           "order": 1,
50           "isHiddenForConnectUsers": false
51         }
52       ],
53       "taskDependencyTemplates": [
54         {
55           "id": "123e4567-e89b-12d3-a456-426614174000",
56           "createdOn": "createdOn",
57           "createdBy": "123e4567-e89b-12d3-a456-426614174000",
58           "updatedOn": "updatedOn",
59           "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
60           "predecessorTemplateId": "f76a7b32-f279-ec11-94f6-dc984040d6c9",
61           "successorTemplateId": "fc8e5a55-e96f-ec11-94f6-dc984040d6c7"
62         }
63       ],
64       "assigneeIds": [
65         "assigneeIds"
66       ],
67       "createdOn": "2022-03-14T10:12:02.100Z",
68       "createdBy": "123e4567-e89b-12d3-a456-426614174000",
69       "updatedOn": "2022-03-25T14:55:30.100Z",
70       "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
71       "order": 4,
72       "hasAttachments": false,
73       "isRecurring": false,
74       "customFields": [
75         {
76           "customFieldDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
77           "userIdValue": "123e4567-e89b-12d3-a456-426614174000",
78           "numberValue": 123.45,
79           "selectionOptionIdValue": "123e4567-e89b-12d3-a456-426614174000",
80           "selectionOption": {
81             "id": "123e4567-e89b-12d3-a456-426614174000",
82             "value": "Website Design",
83             "color": "purple",
84             "order": 0
85           },
86           "textValue": "S1: Business Critical",
87           "dateValue": null,
88           "booleanValue": true
89         }
90       ],
91       "tags": [
92         {
93           "id": "123e4567-e89b-12d3-a456-426614174000",
94           "name": "Design",
95           "color": "purple"
96         }
97       ]
98     }
99   ]
100 }

Returns the task bundle with the specified id.

Required Permissions

Any authenticated user.

Path parameters

taskBundleIdUUIDRequired

The id of the task bundle.

Response

namestring or nullOptional

The name of the task bundle. Required if its not related to a task bundle.

descriptionstring or nullOptional

The description of the task bundle.

iconstring or nullOptional

The icon of the task bundle.

projectTemplateIdUUID or nullOptional

The project template id of the task bundle, only necessary for the creation of an empty bundle for a project template.

idUUIDOptional

The id of the task bundle.

createdOndatetimeOptional

The date this task bundle was created.

createdByUUIDOptional

The id of the user who created this task bundle.

updatedOndatetimeOptional

The date this task bundle was last modified.

updatedByUUIDOptional

The id of the user who last modified this task bundle.

taskListslist of objectsOptional

The list templates within this task bundle.

taskslist of objectsOptional

The task templates within this task bundle.

Required Permissions

Path parameters

Headers

Response