--- title: "Gets a task bundle by id." method: GET path: "/taskbundles/{taskBundleId}" tags: ["taskBundles"] --- # Gets a task bundle by id. `GET /taskbundles/{taskBundleId}` Any authenticated user. ## Path parameters - `taskBundleId` string, uuid, required ## Headers - `Authorization` string, required ## Response `200` OK - TaskBundle - `name` string, nullable — The name of the task bundle. Required if its not related to a task bundle. - `description` string, nullable — The description of the task bundle. - `icon` string, nullable — The icon of the task bundle. - `projectTemplateId` string, uuid, nullable — The project template id of the task bundle, only necessary for the creation of an empty bundle for a project template. - `id` string, uuid — The id of the task bundle. - `createdOn` string, date-time — The date this task bundle was created. - `createdBy` string, uuid — The id of the user who created this task bundle. - `updatedOn` string, date-time — The date this task bundle was last modified. - `updatedBy` string, uuid — The id of the user who last modified this task bundle. - `taskLists` TaskListTemplate[], nullable — The list templates within this task bundle. - `id` string, uuid — The id of the task list template. - `name` string, nullable — The name of the task list template. - `orderOfTask` number, double — The order of the task template in the task list template. - `order` number, double — The order of the task list template, unique within the task bundle. - `isHiddenForConnectUsers` boolean — True if the task in this list is not visible for external workspace users. - `tasks` TaskTemplate[], nullable — The task templates within this task bundle. - `name` string, nullable — The name of the task created from this template. - `description` string, nullable — The description of the task created from this template. - `isPrio` boolean — Whether the task created from this template will be marked as priority. - `plannedDuration` integer — The expected planned workload of the task created from this template, in seconds. - `relativeStartOn` integer, nullable — The relative start date and time of the task created from this template, in seconds, from the moment of creating the task. - `relativeDueOn` integer, nullable — The relative due date and time of the task created from this template, in seconds, from the moment of creating the task. - `typeOfWorkId` string, uuid — The id of the type of work of this task. - `assignedRoleId` string, uuid, nullable — The id of the assigned role of this task. - `parentId` string, uuid, nullable — The id of the parent task template if the task template is a subtask. - `subtaskOrder` number, double, nullable — The order of the subtask template relative to its parent task template. - `laneOrder` integer, nullable — The lane order defines the vertical position in the planner. - `id` string, uuid — The Id of the task template. - `taskType` TypeOfWork — The task type model. - `id` string, uuid — The id of the task type. - `name` string, nullable — The name of the task type. - `description` string, nullable — A short (max. 140 characters) description of the task type. - `icon` string, nullable — The icon associated with this task type. - `isArchived` boolean — Whether the type of work has been archived. - `createdOn` string, date-time — The date this entity was created. - `createdBy` string, uuid — The id of the user who created this entity. - `updatedOn` string, date-time — The date this entity was last modified. - `updatedBy` string, uuid — The id of the user who last modified this entity. - `taskListTemplate` TaskListTemplate[], nullable — The task list templates of the task template. - `id` string, uuid — The id of the task list template. - `name` string, nullable — The name of the task list template. - `orderOfTask` number, double — The order of the task template in the task list template. - `order` number, double — The order of the task list template, unique within the task bundle. - `isHiddenForConnectUsers` boolean — True if the task in this list is not visible for external workspace users. - `taskDependencyTemplates` TaskDependencyTemplate[], nullable — The list of task dependency templates for that task template. - `id` string, uuid — The id of the entity. - `createdOn` string, date-time — The date this entity was created. - `createdBy` string, uuid — The id of the user who created this entity. - `updatedOn` string, date-time — The date this entity was last modified. - `updatedBy` string, uuid — The id of the user who last modified this entity. - `predecessorTemplateId` string, uuid — The id of the predecessor task template. - `successorTemplateId` string, uuid — The id of the successor task template. - `assigneeIds` string[], nullable — The list of assigned users to that task template. - `createdOn` string, date-time — The date this task was created. - `createdBy` string, uuid — The id of the user who created this task. - `updatedOn` string, date-time — The date this task was last modified. - `updatedBy` string, uuid — The id of the user who last modified this task. - `order` number, double, nullable — For internal purposes. - `hasAttachments` boolean — If the task template has attachments. - `isRecurring` boolean — If the task is a recurrency template, the flag is true. - `customFields` CustomField[], nullable — The Custom fields of the task template. - `customFieldDefinitionId` string, uuid — The custom field definition id. - `userIdValue` string, uuid, nullable — The the user id value. - `clientIdValue` string, uuid, nullable — The client id value. - `numberValue` number, double, nullable — The number value. - `selectionOptionIdValue` string, uuid, nullable — The selection option id value. - `selectionOption` CustomFieldSelectionOption - `id` string, uuid — The id of the custom field selection option. - `value` string, required — The selection value which can be later used in a select custom field. - `color` 'red' | 'orange' | 'yellow' | 'green' | 'cyan' | 'blue' | 'indigo' | 'purple' | 'steel' — The color of the selection option. - `order` number, double — The order of the custom field selection option. - `textValue` string, nullable — The text value. - `dateValue` string, date-time, nullable — The date value. - `booleanValue` boolean, nullable — The boolean value. - `tags` TaskTemplateTagModel[], nullable — The list of tags that will be applied to the task when it is created. - `id` string, uuid - `name` string, nullable — The name of the tag. - `color` string, nullable — The color of the tag. - `hasRelativeTasks` boolean — True if any of the tasks in the bundle has relative dates. ## Other responses - `404` — Not Found --- [API](https://skmtc.net/awork-io/apis/api-v1-reference.md) · [All operations](https://skmtc.net/awork-io/apis/api-v1-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/awork-io/api-v1-reference/versions/f784a53f60df/schema)