Lists task bundles.

GET

https://api.awork.com/api/v1/taskbundles

GET

/api/v1/taskbundles

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

200Retrieved

[
  {
    "name": "Project Kickoff",
    "description": "Includes all tasks related to getting this project off the ground successfully. For the joy of work!",
    "icon": "arrow_forward",
    "projectTemplateId": "f76a7b32-f279-ec11-94f6-dc984040d6c9",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdOn": "2022-03-11T17:53:46.100Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedOn": "2022-03-13T11:20:00.100Z",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "taskLists": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Concept Desing",
        "orderOfTask": 2,
        "order": 1,
        "isHiddenForConnectUsers": true
      }
    ],
    "tasks": [
      {
        "name": "Wireframe layout",
        "description": "Create the wireframe layout ready to be discussed with the stakeholders",
        "isPrio": false,
        "plannedDuration": 1400,
        "relativeStartOn": 1,
        "relativeDueOn": 1,
        "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
        "assignedRoleId": "123e4567-e89b-12d3-a456-426614174000",
        "parentId": "123e4567-e89b-12d3-a456-426614174000",
        "subtaskOrder": 1,
        "laneOrder": 2,
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "taskType": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Sales Work",
          "description": "Tasks related to sales dept.",
          "icon": "attach_money",
          "isArchived": true,
          "createdOn": "2022-03-10T16:25:09.100Z",
          "createdBy": "123e4567-e89b-12d3-a456-426614174000",
          "updatedOn": "2022-03-10T18:55:00.500Z",
          "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
        },
        "taskListTemplate": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Concept Desing",
            "orderOfTask": 2,
            "order": 1,
            "isHiddenForConnectUsers": true
          }
        ],
        "taskDependencyTemplates": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "createdOn": "2022-03-11T15:33:47.100Z",
            "createdBy": "123e4567-e89b-12d3-a456-426614174000",
            "updatedOn": "2022-03-11T21:15:00.100Z",
            "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
            "predecessorTemplateId": "f76a7b32-f279-ec11-94f6-dc984040d6c9",
            "successorTemplateId": "fc8e5a55-e96f-ec11-94f6-dc984040d6c7"
          }
        ],
        "assigneeIds": [
          "string"
        ],
        "createdOn": "2022-03-14T10:12:02.100Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000",
        "updatedOn": "2022-03-25T14:55:30.100Z",
        "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
        "order": 4,
        "hasAttachments": true,
        "isRecurring": false,
        "customFields": [
          {
            "customFieldDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
            "userIdValue": "123e4567-e89b-12d3-a456-426614174000",
            "clientIdValue": "123e4567-e89b-12d3-a456-426614174000",
            "numberValue": 123.45,
            "selectionOptionIdValue": "123e4567-e89b-12d3-a456-426614174000",
            "selectionOption": {
              "value": "Website Design",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "color": "purple",
              "order": 0
            },
            "textValue": "S1: Business Critical",
            "dateValue": "2024-01-15T09:30:00Z",
            "booleanValue": true
          }
        ],
        "tags": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Design",
            "color": "purple"
          }
        ]
      }
    ],
    "hasRelativeTasks": true
  }
]

Required Permissions

Any authenticated user.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

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

Query parameters

pageintegerOptionalDefaults to 1

Page number for pagination

pageSizeintegerOptionalDefaults to 10

Number of items per page

orderbystringOptional

The properties to order by

filterbystringOptional

The filter expression to filter by

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.

projectTemplateIdstring or nullOptionalformat: "uuid"

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

idstringOptionalformat: "uuid"

The id of the task bundle.

createdOnstringOptionalformat: "date-time"

The date this task bundle was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this task bundle.

updatedOnstringOptionalformat: "date-time"

The date this task bundle was last modified.

updatedBystringOptionalformat: "uuid"

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

taskListslist of objects or nullOptional

The list templates within this task bundle.

taskslist of objects or nullOptional

The task templates within this task bundle.

hasRelativeTasksbooleanOptionalRead-only

True if any of the tasks in the bundle has relative dates.