API v1 ReferenceProjects

Creates a new project.

Creates a new project.

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

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
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.

startDatedatetime or nullOptional

The start date of the project.

dueDatedatetime or nullOptional

The due date of the project.

companyIdUUID or nullOptional

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.

projectTypeIdUUID or nullOptional

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.

projectStatusIdUUID or nullOptional

The id of the project status.

projectTemplateIdUUID or nullOptional

The id of the template which is used to create the project.

publicProjectTemplateIdUUID or nullOptional

The id of the public template which is used to create the project.

Response

OK

namestring>=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.

startDatedatetime or nullOptional

The start date of the project.

dueDatedatetime or nullOptional

The due date of the project.

companyIdUUID or nullOptional

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.

projectTypeIdUUID or nullOptional

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.

projectStatusIdUUID or nullOptional

The id of the project status.

projectTemplateIdUUID or nullOptional

The id of the template which is used to create the project.

publicProjectTemplateIdUUID or nullOptional

The id of the public template which is used to create the project.

idUUIDOptional

Id of the project.

hasImagebooleanOptional

Whether the project has an image.

createdOndatetimeOptional

The date this entity was created.

createdByUUIDOptional

The id of the user who created this entity.

updatedOndatetimeOptional

The date this entity was last modified.

updatedByUUIDOptional

The id of the user who last modified this entity.

closedOndatetime or nullOptional

The date the project was set to closed.

closedByUUID or nullOptional

The user who closed the project.

createdByProjectTemplateIdUUID or nullOptional

The id of the template the project was created from.

projectTypeobjectOptional
projectStatusobjectOptional
companyobjectOptional
tagslist of objectsOptional

The tags for this project.

plannedDurationlong or nullOptional

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

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 objectsOptional

The members of this project.

trackedDurationinteger or nullOptional

The summed up duration of all time trackings for this project.

resourceVersionlongOptional

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

teamslist of objectsOptional

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.