Retrieves a paginated list of all project templates with details. | awork API

import requests
url = "https://api.awork.com/api/v1/projecttemplates"
payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.json())

[
  {
    "id": "a3f1c9d2-4b7e-4f8a-9c2d-5e6f7a8b9c0d",
    "name": "Website Redesign Template",
    "description": "Template for a comprehensive website redesign project including design, development, and testing phases.",
    "createdOn": "2023-11-10T08:45:00Z",
    "createdBy": "d2f3e4a5-b678-4c9d-8e7f-123456789abc",
    "updatedOn": "2024-04-20T14:22:00Z",
    "updatedBy": "d2f3e4a5-b678-4c9d-8e7f-123456789abc",
    "isBillableByDefault": "auto",
    "defaultTaskListIdForEmails": "f1e2d3c4-b5a6-7890-1234-56789abcdef0",
    "projectStatuses": [
      {
        "id": "b1c2d3e4-f5a6-7890-1234-56789abcdef0",
        "name": "Planning",
        "type": "progress",
        "order": 1,
        "createdOn": "2023-11-10T08:45:00Z",
        "createdBy": "d2f3e4a5-b678-4c9d-8e7f-123456789abc",
        "updatedOn": "2024-04-20T14:22:00Z",
        "projectTemplateId": "a3f1c9d2-4b7e-4f8a-9c2d-5e6f7a8b9c0d",
        "workflowId": "c3d4e5f6-a7b8-9012-3456-789abcdef012",
        "updatedBy": "d2f3e4a5-b678-4c9d-8e7f-123456789abc",
        "isExternal": false
      },
      {
        "id": "c3d4e5f6-a7b8-9012-3456-789abcdef012",
        "name": "In Progress",
        "type": "progress",
        "order": 2,
        "createdOn": "2023-11-10T08:45:00Z",
        "createdBy": "d2f3e4a5-b678-4c9d-8e7f-123456789abc",
        "updatedOn": "2024-04-20T14:22:00Z",
        "projectTemplateId": "a3f1c9d2-4b7e-4f8a-9c2d-5e6f7a8b9c0d",
        "workflowId": "c3d4e5f6-a7b8-9012-3456-789abcdef012",
        "updatedBy": "d2f3e4a5-b678-4c9d-8e7f-123456789abc",
        "isExternal": false
      },
      {
        "id": "d5e6f7a8-b9c0-1234-5678-9abcdef01234",
        "name": "Completed",
        "type": "progress",
        "order": 3,
        "createdOn": "2023-11-10T08:45:00Z",
        "createdBy": "d2f3e4a5-b678-4c9d-8e7f-123456789abc",
        "updatedOn": "2024-04-20T14:22:00Z",
        "projectTemplateId": "a3f1c9d2-4b7e-4f8a-9c2d-5e6f7a8b9c0d",
        "workflowId": "c3d4e5f6-a7b8-9012-3456-789abcdef012",
        "updatedBy": "d2f3e4a5-b678-4c9d-8e7f-123456789abc",
        "isExternal": false
      }
    ],
    "hasImage": true,
    "copyImageToProjectOnCreation": true,
    "projectTypeId": "e7f8a9b0-c1d2-3456-7890-abcdef123456",
    "workflowId": "c3d4e5f6-a7b8-9012-3456-789abcdef012",
    "timeBudget": 864000,
    "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

idstringformat: "uuid"

The id of the template.

namestring or null

The name of the template.

descriptionstring or null

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.

createdOndatetime

The date this entity was created.

createdBystringformat: "uuid"

The id of the user who created this entity.

updatedOndatetime

The date this entity was last modified.

updatedBystringformat: "uuid"

The id of the user who last modified this entity.

isBillableByDefaultstring or null

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

defaultTaskListIdForEmailsstring or nullformat: "uuid"

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

projectStatuseslist of objects or null

The project statuses of the template.

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

The id of the project type.

workflowIdstring or nullformat: "uuid"

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.