SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceProjects

Creates a new project.

POST
https://api.awork.com/api/v1/projects
POST
/api/v1/projects
1curl -X POST https://api.awork.com/api/v1/projects \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "name": "Website Design"
6}'
Try it
200Successful
1{
2  "name": "Website Design",
3  "isPrivate": false,
4  "description": "Sitemap, design, assets and implementation of the new online presence.",
5  "startDate": "2022-03-01T00:00:00Z",
6  "dueDate": "2022-05-01T00:00:00Z",
7  "companyId": "123e4567-e89b-12d3-a456-426614174000",
8  "timeBudget": 576000,
9  "isBillableByDefault": true,
10  "projectTypeId": "123e4567-e89b-12d3-a456-426614174000",
11  "color": "purple",
12  "deductNonBillableHours": true,
13  "projectStatusId": "123e4567-e89b-12d3-a456-426614174000",
14  "projectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
15  "publicProjectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
16  "id": "123e4567-e89b-12d3-a456-426614174000",
17  "hasImage": true,
18  "createdOn": "2024-01-15T09:30:00Z",
19  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
20  "updatedOn": "2024-01-15T09:30:00Z",
21  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
22  "closedOn": "2024-01-15T09:30:00Z",
23  "closedBy": "123e4567-e89b-12d3-a456-426614174000",
24  "createdByProjectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
25  "projectType": {
26    "id": "123e4567-e89b-12d3-a456-426614174000",
27    "name": "string",
28    "icon": "string",
29    "isArchived": true
30  },
31  "projectStatus": {
32    "id": "123e4567-e89b-12d3-a456-426614174000",
33    "name": "string",
34    "description": "string",
35    "type": "string",
36    "isArchived": true,
37    "typeOrder": 1,
38    "isExternal": true
39  },
40  "company": {
41    "id": "123e4567-e89b-12d3-a456-426614174000",
42    "name": "string",
43    "hasImage": true,
44    "description": "A brand strategy and design agency",
45    "tags": [
46      {
47        "id": "123e4567-e89b-12d3-a456-426614174000",
48        "name": "string",
49        "color": "string",
50        "entityId": "123e4567-e89b-12d3-a456-426614174000"
51      }
52    ]
53  },
54  "tags": [
55    {
56      "id": "123e4567-e89b-12d3-a456-426614174000",
57      "name": "Design",
58      "color": "purple"
59    }
60  ],
61  "totalPlannedDurationWithHierarchy": 432000,
62  "tasksCount": 12,
63  "tasksDoneCount": 3,
64  "members": [
65    {
66      "id": "123e4567-e89b-12d3-a456-426614174000",
67      "userId": "123e4567-e89b-12d3-a456-426614174000",
68      "firstName": "Lisa",
69      "lastName": "Smith",
70      "hasImage": true,
71      "projectRoleId": "123e4567-e89b-12d3-a456-426614174000",
72      "projectRoleName": "Project Manager",
73      "isResponsible": true,
74      "isDeactivated": false,
75      "isExternal": true
76    }
77  ],
78  "trackedDuration": 72000,
79  "customFields": [
80    {
81      "customFieldDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
82      "userIdValue": "123e4567-e89b-12d3-a456-426614174000",
83      "numberValue": 123,
84      "selectionOptionIdValue": "123e4567-e89b-12d3-a456-426614174000",
85      "selectionOption": {
86        "value": "Website Design",
87        "order": 0,
88        "id": "123e4567-e89b-12d3-a456-426614174000",
89        "color": "red"
90      },
91      "textValue": "S1: Business Critical",
92      "dateValue": "2024-01-15T09:30:00Z",
93      "booleanValue": true
94    }
95  ],
96  "resourceVersion": 637825154598057900,
97  "teams": [
98    {
99      "id": "123e4567-e89b-12d3-a456-426614174000",
100      "name": "Designers",
101      "icon": "paintbrush",
102      "color": "purple"
103    }
104  ],
105  "isExternal": true,
106  "isRetainer": true,
107  "plannedDuration": 432000
108}
Creates a new project. <Check title="Required Permissions">The user must be an admin or have `project-create:write` permissions.</Check>
Was this page helpful?
Previous

Creates the preconfigured project in the language of the user.

Next
Built with
Creates the preconfigured project in the language of the user.

Authentication

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

Request

The model used to create a project.
namestringRequired>=0 characters<=1000 characters
The name of the Project. Max allowed length: 1000 characters.
isPrivatebooleanOptional
Whether this is a private project only visible to members and the creator. Defaults to false. Can only be changed from public to private if no times have been tracked on this project. Can always be made public.
descriptionstring or nullOptional>=0 characters<=25000 characters
The project description. Max allowed length: 25000 characters.
startDatestring or nullOptionalformat: "date-time"
The start date of the project.
dueDatestring or nullOptionalformat: "date-time"
The due date of the project.
companyIdstring or nullOptionalformat: "uuid"
The id of the company.
timeBudgetinteger or nullOptional
The time budget the project has, in seconds.
isBillableByDefaultboolean or nullOptional
Whether project times should be billable by default.
projectTypeIdstring or nullOptionalformat: "uuid"
The id of the project type of this project.
colorstring or nullOptional>=0 characters<=14 characters
The color of the project for display purposes in awork. The supported colors are defined by the awork frontend. Can be null when no color assigned.
deductNonBillableHoursbooleanOptional
Whether to deduct non-billable hours from project budgets.
projectStatusIdstring or nullOptionalformat: "uuid"
The id of the project status.
projectTemplateIdstring or nullOptionalformat: "uuid"
The id of the template which is used to create the project.
publicProjectTemplateIdstring or nullOptionalformat: "uuid"
The id of the public template which is used to create the project.
referenceDateTypeenum or nullOptional
(optional, default = TODAY) Defines the starting date from which the reference date is calculated. The reference date is the date from which the Start/DueOn date of a task is calculated, based on the ReferenceDateAnchor.
Allowed values:
referenceDateAnchorenum or nullOptional
(optional, default = START) Defines what the reference date represents for the schedule (start of first task or end of last task).
Allowed values:
customReferenceDatestring or nullOptionalformat: "date"
(optional) The custom reference date when ReferenceDateType is set to 'custom'.

Response

OK
namestring>=0 characters<=1000 characters
The name of the Project. Max allowed length: 1000 characters.
isPrivateboolean or null
Whether this is a private project only visible to members and the creator. Defaults to false. Can only be changed from public to private if no times have been tracked on this project. Can always be made public.
descriptionstring or null>=0 characters<=25000 characters
The project description. Max allowed length: 25000 characters.
startDatestring or nullformat: "date-time"
The start date of the project.
dueDatestring or nullformat: "date-time"
The due date of the project.
companyIdstring or nullformat: "uuid"
The id of the company.
timeBudgetinteger or null
The time budget the project has, in seconds.
isBillableByDefaultboolean or null
Whether project times should be billable by default.
projectTypeIdstring or nullformat: "uuid"
The id of the project type of this project.
colorstring or null>=0 characters<=14 characters
The color of the project for display purposes in awork. The supported colors are defined by the awork frontend. Can be null when no color assigned.
deductNonBillableHoursboolean or null
Whether to deduct non-billable hours from project budgets.
projectStatusIdstring or nullformat: "uuid"
The id of the project status.
projectTemplateIdstring or nullformat: "uuid"
The id of the template which is used to create the project.
publicProjectTemplateIdstring or nullformat: "uuid"
The id of the public template which is used to create the project.
idstring or nullformat: "uuid"
Id of the project.
hasImageboolean or null
Whether the project has an image.
createdOnstring or nullformat: "date-time"
The date this entity was created.
createdBystring or nullformat: "uuid"
The id of the user who created this entity.
updatedOnstring or nullformat: "date-time"
The date this entity was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this entity.
closedOnstring or nullformat: "date-time"
The date the project was set to closed.
closedBystring or nullformat: "uuid"
The user who closed the project.
createdByProjectTemplateIdstring or nullformat: "uuid"
The id of the template the project was created from.
projectTypeobject or null
projectStatusobject or null
companyobject or null
tagslist of objects or null
The tags for this project.
totalPlannedDurationWithHierarchylong or null
The total planned duration of the project with hierarchy, in seconds. Calculated based on the planned durations of tasks and task lists of the project. Sum of Sum(TotalPlannedDurationWithHierarchy of all task lists) and Sum(TotalPlannedDurationWithHierarchy of all parent tasks without list)
tasksCountinteger or null
The number of all tasks related to the project.
tasksDoneCountinteger or null
The number of all tasks in status 'done' related to the project.
memberslist of objects or null
The members of this project.
trackedDurationinteger or null
The summed up duration of all time trackings for this project.
customFieldslist of objects or null
Custom fields of the project.
resourceVersionlong or null
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
teamslist of objects or null
The teams the project is associated to.
isExternalboolean or null
True if this entity is coming from an external workspace (awork Connect).
isRetainerboolean or null
Whether the project is a retainer project. Retainer projects have at least one retainer with budgets.
plannedDurationlong or nullDeprecated
The total planned time of the project, in seconds. The time is calculated as te sum of the planned duration by all project tasks.
The start date of the project.
The due date of the project.
The id of the company.
The time budget the project has, in seconds.
Whether project times should be billable by default.
The id of the project type of this project.
The color of the project for display purposes in awork. The supported colors are defined by the awork frontend. Can be null when no color assigned.
The id of the project status.
The id of the template which is used to create the project.
The id of the public template which is used to create the project.
Id of the project.
Whether the project has an image.
The date this entity was created.
The id of the user who created this entity.
The date this entity was last modified.
The id of the user who last modified this entity.
The date the project was set to closed.
The user who closed the project.
The id of the template the project was created from.
The tags for this project.
The number of all tasks related to the project.
The number of all tasks in status 'done' related to the project.
The members of this project.
The summed up duration of all time trackings for this project.
Custom fields of the project.
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
The teams the project is associated to.
Whether the project is a retainer project. Retainer projects have at least one retainer with budgets.
The total planned time of the project, in seconds. The time is calculated as te sum of the planned duration by all project tasks.
The start date of the project.
The due date of the project.
The id of the company.
The time budget the project has, in seconds.
Whether project times should be billable by default.
The id of the project type of this project.
The color of the project for display purposes in awork. The supported colors are defined by the awork frontend. Can be null when no color assigned.
The id of the project status.
The id of the template which is used to create the project.
The id of the public template which is used to create the project.
OK

The project description. Max allowed length: 25000 characters.

Creates a new project.

Required Permissions
The user must be an admin or have project-create:write permissions.

The name of the Project. Max allowed length: 1000 characters.

The name of the Project. Max allowed length: 1000 characters.

The project description. Max allowed length: 25000 characters.

True if this entity is coming from an external workspace (awork Connect).

The total planned duration of the project with hierarchy, in seconds. Calculated based on the planned durations of tasks and task lists of the project. Sum of Sum(TotalPlannedDurationWithHierarchy of all task lists) and Sum(TotalPlannedDurationWithHierarchy of all parent tasks without list)

Whether to deduct non-billable hours from project budgets.

Whether to deduct non-billable hours from project budgets.

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

(optional, default = TODAY) Defines the starting date from which the reference date is calculated. The reference date is the date from which the Start/DueOn date of a task is calculated, based on the ReferenceDateAnchor.

(optional, default = START) Defines what the reference date represents for the schedule (start of first task or end of last task).

(optional) The custom reference date when ReferenceDateType is set to ‘custom’.