projectTemplates

Returns a specific project template.

Changed on

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

get/projecttemplates/{projectTemplateId}

Request

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

Path parameters

projectTemplateIdstring uuid required

The id of the project template to retrieve.

Response

OK

idstring uuid

The id of the template.

namestring nullable

The name of the template.

descriptionstring nullable

The description that will be used for the project created from this template. It will be appended to the project description provided by the user.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

isBillableByDefaultstring nullable

Whether project times should be billable by default, if the project was created by this template. Can be 'on', 'off', or 'auto'.

defaultTaskListIdForEmailsstring uuid nullable

The id references the task list, which is used to assign tasks created by email to.

hasImageboolean

Whether the project template has an image in the files service.

copyImageToProjectOnCreationboolean

Whether the template image should be copied to the project during project creation. If the template has no image, no image is copied. No image is copied from the client.

projectTypeIdstring uuid nullable

The id of the project type.

workflowIdstring uuid nullable

The id of the workflow linked to this template.

timeBudgetinteger

The amount of time budgeted for the project in seconds.

hasRelativeTasksboolean

True if any of the tasks of the template has relative dates.

Changes

  • 84f37b3c4cbcRevision 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