Operations with Specific Project - Help | Developer Portal for YouTrack and Hub

Project attributes

Represents a YouTrack project.

Related Resources

Below you can find the list of resources that let you work with this entity.

Attributes

This table describes attributes of the Project entity.

To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
id	String	The database ID of the project. `Read-only`.
archived	Boolean	If the project is currently archived, this property is `true`.
createdBy	User	The user who created the project. `Can be null`.
customFields	ProjectCustomField	The set of custom fields that are available in the project.
description	String	The description of the project as shown on the project profile page. `Can be null`.
fromEmail	String	The email address that is used to send notifications for the project. If a 'From' address is not set for the project, the default 'From' address for the YouTrack server is returned.
iconUrl	String	The URL of the icon of the project. `Read-only`. `Can be null`.
issues	Array of Issues	A list of all issues that belong to the project.
leader	User	The user who is set as the project owner. `Can be null`.
name	String	The name of the project. `Can be null`.
replyToEmail	String	The email address that is used as the reply email to send notifications for the project. If it is not set for the project, the default address for the YouTrack server is returned. `Can be null`.
shortName	String	The ID of the project. This short name is also a prefix for an issue ID. `Can be null`.
startingNumber	Long	Starting number for issues in project. This property can be set only during creation of the new project.
team	UserGroup	Read-only user group representing all members of the project team. `Read-only`.
template	Boolean	If `true`, this project is a template.

Read a Specific Project

Get the settings of the specific project.

Required permissions

Requires permissions: Read Project Basic or Update Project

Request syntax

GET /api/admin/projects/{projectID}?{fields}

{projectID}

ID of the project. To identify the project, you can use either its database entity ID or the short name.

Request parameters

Parameter	Type	Description
fields	String	A list of Project attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.

Sample

Sample request

                https://example.youtrack.cloud/api/admin/projects/0-6?fields=id,name,timeTrackingEnabled,shortName,leader(login,name,id),description,createdBy(login,name,id)
            

Sample response body

                {
                  "description": "A project created using REST API",
                  "leader": {
                    "login": "root",
                    "name": "John Smith",
                    "id": "1-1",
                    "$type": "User"
                  },
                  "shortName": "RP",
                  "createdBy": {
                    "login": "john.doe",
                    "name": "John Doe",
                    "id": "1-2",
                    "$type": "User"
                  },
                  "name": "Rest Project",
                  "id": "0-6",
                  "$type": "Project"
                }
            

Update a Specific Project

Update settings of a project with a specific ID.

Required permissions

Requires permissions: Update Project

Request syntax

POST /api/admin/projects/{projectID}?{fields}

{projectID}

ID of the project. To identify the project, you can use either its database entity ID or the short name.

Request parameters

Parameter	Type	Description
fields	String	A list of Project attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.

Sample

Sample request

                https://example.youtrack.cloud/api/admin/projects/0-6?fields=id,name,timeTrackingEnabled,shortName,leader(login,name,id),description,createdBy(login,name,id)
            

Sample request body

                {
                  "leader":{"id":"1-1"},
                  "description":"A project created using REST API"
                }
            

Sample response body

                {
                  "description": "A project created using REST API",
                  "leader": {
                    "login": "root",
                    "name": "John Smith",
                    "id": "1-1",
                    "$type": "User"
                  },
                  "shortName": "RP",
                  "createdBy": {
                    "login": "john.doe",
                    "name": "John Doe",
                    "id": "1-2",
                    "$type": "User"
                  },
                  "name": "Rest Project",
                  "id": "0-6",
                  "$type": "Project"
                }
            

Delete a Specific Project

Delete a project with specific ID.

Request syntax

DELETE /api/admin/projects/{projectID}

{projectID}

ID of the project. To identify the project, you can use either its database entity ID or the short name.

Request parameters

Parameter	Type	Description
fields	String	A list of Project attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.

Sample

Identify the target project by its entity ID. For a successful request, server returns 200 OK code and an empty response payload.

Sample request

https://example.youtrack.cloud/api/admin/projects/0-15

Resource	/api/admin/projects/{projectID}
Returned entity	Project. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a Specific Project. `POST`: Update a Specific Project. `DELETE`: Delete a Specific Project.