API v1 ReferenceProjects

Creates a new project.

Creates a new project. <Check title="Required Permissions" icon="key">The user must be an admin or have `project-create:write` permissions.</Check>

Authentication

AuthorizationBearer

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

Request

The model to create the project.
namestringRequired0-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 nullOptional0-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 nullOptional0-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.

isProjectKeyVisibleboolean or nullOptional
Whether project key should be visible for this project. If null, it will use the workspace default setting.
projectStatusIdstring or nullOptionalformat: "uuid"
Optional existing status to use when creating from a workflow or template source.
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.
workflowIdstring or nullOptionalformat: "uuid"
The id of the workflow to link to the project. Cannot be specified if ProjectTemplateId is set.
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.

referenceDateAnchorenum or nullOptional

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

customReferenceDatestring or nullOptionalformat: "date"

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

Response

OK
namestring0-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 nullOptional0-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 nullOptional0-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.

isProjectKeyVisibleboolean or nullOptional
Whether project key should be visible for this project. If null, it will use the workspace default setting.
projectStatusIdstringOptionalformat: "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.
workflowIdstring or nullOptionalformat: "uuid"
The id of the workflow to link to the project. Cannot be specified if ProjectTemplateId is set.
idstringOptionalformat: "uuid"
Id of the project.
projectKeystring or nullOptional

The unique project key within the workspace (e.g., “NIKE”). Maximum 32 characters, uppercase letters, numbers, and dashes only.

hasImagebooleanOptional
Whether the project has an image.
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.
closedOnstring or nullOptionalformat: "date-time"
The date the project was set to closed.
closedBystring or nullOptionalformat: "uuid"
The user who closed the project.
createdByProjectTemplateIdstring or nullOptionalformat: "uuid"
The id of the template the project was created from.
projectTypeobjectOptional
projectStatusobjectOptional
companyobjectOptional
tagslist of objects or nullOptional
The tags for this project.
totalPlannedDurationWithHierarchylong or nullOptional

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 nullOptional
The number of all tasks related to the project.
tasksDoneCountinteger or nullOptional
The number of all tasks in status 'done' related to the project.
memberslist of objects or nullOptional
The members of this project.
trackedDurationinteger or nullOptional
The summed up duration of all time trackings for this project.
customFieldslist of objects or nullOptional
Custom fields of the project.
resourceVersionlongOptionalRead-only
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
teamslist of objects or nullOptional
The teams the project is associated to.
isExternalbooleanOptional

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

isRetainerbooleanOptional
Whether the project is a retainer project. Retainer projects have at least one retainer with budgets.
isMultiAssignmentAllowedbooleanOptional

Indicates whether multi-assignment is allowed for tasks in this project’s workspace.

plannedDurationlong or nullOptionalDeprecated
The total planned time of the project, in seconds. The time is calculated as te sum of the planned duration by all project tasks.

Errors

400
Bad Request Error