Returns the project with the specified id.
Returns the project with the specified id if the user has read
permissions of feature project-master-data
.
Required Permissions
Any authenticated user.Path parameters
projectId
The id of the project.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
OK
name
The name of the Project. Max allowed length: 1000 characters.
isPrivate
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.
description
The project description. Max allowed length: 25000 characters.
startDate
The start date of the project.
dueDate
The due date of the project.
companyId
The id of the company.
timeBudget
The time budget the project has, in seconds.
isBillableByDefault
Whether project times should be billable by default.
projectTypeId
The id of the project type of this project.
color
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.
deductNonBillableHours
Whether to deduct non-billable hours from project budgets.
projectStatusId
The id of the project status.
projectTemplateId
The id of the template which is used to create the project.
publicProjectTemplateId
The id of the public template which is used to create the project.
id
Id of the project.
hasImage
Whether the project has an image.
createdOn
The date this entity was created.
createdBy
The id of the user who created this entity.
updatedOn
The date this entity was last modified.
updatedBy
The id of the user who last modified this entity.
closedOn
The date the project was set to closed.
closedBy
The user who closed the project.
createdByProjectTemplateId
The id of the template the project was created from.
projectType
projectStatus
company
plannedDuration
The total planned time of the project, in seconds.
The time is calculated as te sum of the planned duration by all project tasks.
tasksCount
The number of all tasks related to the project.
tasksDoneCount
The number of all tasks in status 'done' related to the project.
members
The members of this project.
trackedDuration
The summed up duration of all time trackings for this project.
customFields
Custom fields of the project.
resourceVersion
The version of the entity, updated on every modification, to the ticks in UTC.
Not identical to UpdatedOn.
teams
The teams the project is associated to.
isExternal
True if this entity is coming from an external workspace (awork Connect).
isRetainer
Whether the project is a retainer project.
Retainer projects have at least one retainer with budgets.