taskBundles

Returns a task bundle by id.

Changed on

Returns a task bundle by id. The response includes the bundle's configuration. <Check title="Required Permissions" icon="key">The user must have permission to access the requested resource.</Check>

get/taskbundles/{taskBundleId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/taskbundles/{taskBundleId}
  • Auth: HTTP bearer

Path parameters

taskBundleIdstring uuid required

The id of the task bundle.

Response

OK

namestring nullable

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

descriptionstring nullable

The description of the task bundle.

iconstring nullable

The icon of the task bundle.

projectTemplateIdstring uuid nullable

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

idstring uuid

The id of the task bundle.

createdOnstring date-time

The date this task bundle was created.

createdBystring uuid

The id of the user who created this task bundle.

updatedOnstring date-time

The date this task bundle was last modified.

updatedBystring uuid

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

hasRelativeTasksboolean

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

Changes

  • ab257be657b1Revision changes
    • info

      added the optional property // to the response with the status

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API