Retrieves all project templates.

GET

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

GET

/api/v1/projecttemplates

$ curl https://api.awork.com/api/v1/projecttemplates \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 [
2   {
3     "id": "a1b2c3d4-e5f6-7890-ab12-cdef34567890",
4     "name": "Mobile App Development",
5     "description": "A mobile app development project created from a template",
6     "createdOn": "2024-04-10T08:45:00Z",
7     "createdBy": "f1234567-e89b-12d3-a456-426614174001",
8     "updatedOn": "2024-05-01T12:00:00Z",
9     "updatedBy": "f1234567-e89b-12d3-a456-426614174002",
10     "isBillableByDefault": "on",
11     "defaultTaskListIdForEmails": "d2345678-e89b-12d3-a456-426614174003",
12     "hasImage": true,
13     "copyImageToProjectOnCreation": false,
14     "projectTypeId": "b6789012-e89b-12d3-a456-426614174007",
15     "workflowId": "c7890123-e89b-12d3-a456-426614174008",
16     "timeBudget": 72000,
17     "hasRelativeTasks": false,
18     "projectStatuses": [
19       {
20         "id": "e3456789-e89b-12d3-a456-426614174004",
21         "name": "Planning",
22         "type": "progress",
23         "order": 1,
24         "createdOn": "2024-04-10T08:45:00Z",
25         "createdBy": "f1234567-e89b-12d3-a456-426614174001",
26         "updatedOn": "2024-04-15T10:00:00Z",
27         "projectTemplateId": "a1b2c3d4-e5f6-7890-ab12-cdef34567890",
28         "projectId": "b4567890-e89b-12d3-a456-426614174005",
29         "workflowId": "c5678901-e89b-12d3-a456-426614174006",
30         "updatedBy": "f1234567-e89b-12d3-a456-426614174002",
31         "isExternal": false
32       }
33     ]
34   }
35 ]

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

idstringOptionalformat: "uuid"

The id of the template.

namestring or nullOptional

The name of the template.

descriptionstring or nullOptional

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.

createdOnstringOptionalformat: "date-time"

The date this entity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this entity.

updatedOnstringOptionalformat: "date-time"

The date this entity was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this entity.

isBillableByDefaultstring or nullOptional

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

defaultTaskListIdForEmailsstring or nullOptionalformat: "uuid"

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

hasImagebooleanOptional

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

copyImageToProjectOnCreationbooleanOptional

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 or nullOptionalformat: "uuid"

The id of the project type.

workflowIdstring or nullOptionalformat: "uuid"

The id of the workflow linked to this template.

timeBudgetintegerOptional

The amount of time budgeted for the project in seconds.

hasRelativeTasksbooleanOptional

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

projectStatuseslist of objects or nullOptionalDeprecated

Deprecated. Use GET /projectTemplates/{projectTemplateId}/projectStatuses instead. The list of project statuses associated with the template. This can be either workflow statuses or template-specific statuses depending on whether the template is linked to a workflow or not.