Projects
This resource provides access to projects.
Resource | |
|---|---|
Returned entity | Project. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Supported sub-resources |
|
Represents a YouTrack project.
Below you can find the list of resources that let you work with this entity.
Projects
Extends IssueFolder
This table describes attributes of the Project entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest 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. |
archived | Boolean | If the project is currently archived, this property is |
createdBy | The user who created the project. | |
customFields | 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. |
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. |
issues | A list of all issues that belong to the project. | |
leader | The user who is set as the project owner. | |
name | String | The name of the project. |
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. |
shortName | String | The ID of the project. This short name is also a prefix for an issue ID. |
startingNumber | Long | Starting number for issues in project. This property can be set only during creation of the new project. |
team | Read-only user group representing all members of the project team. | |
template | Boolean | If |
Get a list of all available projects in the system.
GET /api/admin/projects?{fields}&{$top}&{$skip}null | Database ID of Project |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Project attributes that should be returned in the response. If no field is specified, only the |
$skip | Int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
$top | Int | Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries. The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination. |
https://example.youtrack.cloud/api/admin/projects?fields=id,name,shortName,createdBy(login,name,id),leader(login,name,id),key&$top=2[
{
"shortName": "KNBN",
"leader": {
"login": "john.doe",
"name": "John Doe",
"id": "1-2",
"$type": "User"
},
"createdBy": {
"login": "john.doe",
"name": "John Doe",
"id": "1-2",
"$type": "User"
},
"name": "Another Kanban project from REST",
"id": "0-14",
"$type": "Project"
},
{
"shortName": "SCR",
"leader": {
"login": "john.doe",
"name": "John Doe",
"id": "1-2",
"$type": "User"
},
"createdBy": {
"login": "john.doe",
"name": "John Doe",
"id": "1-2",
"$type": "User"
},
"name": "AnotherScrum project from REST",
"id": "0-10",
"$type": "Project"
}
]Create a project in YouTrack.
Required fields: name, shortName, leader (id - the database of the project owner user).
To create a project that is based on a template, like Scrum or Kanban, add template query parameter to the endpoint URL. For reference, see Sample 2 below.
Requires permissions: Create Project
POST /api/admin/projects?{fields}&{template}null | Database ID of Project |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Project attributes that should be returned in the response. If no field is specified, only the |
template | String | If the |
This sample shows a minimal viable request to create a new project. To check the attributes of a newly created project, we added fields request parameters.
https://example.youtrack.cloud/api/admin/projects?fields=id,shortName,name,leader(id,login,name){
"description": "A new project created from rest api",
"name": "GRA Project",
"shortName": "GRP",
"leader": {
"id": "1-2"
}
}{
"shortName": "NP",
"leader": {
"login": "john.doe",
"name": "John Doe",
"id": "1-2",
"$type": "User"
},
"name": "New Project",
"id": "0-16",
"$type": "Project"
}This sample shows a request to create a new project with the Scrum template.
https://example.youtrack.cloud/api/admin/projects?fields=id,shortName,name,leader(id,login,name)&template=scrum{
"description": "A new project created with the Scrum template",
"name": "New Scrum Project",
"shortName": "NSCP",
"leader":{
"id":"1-2"
}
}{
"shortName": "NSCP",
"leader": {
"login": "minnie.terry",
"name": "Minnie Terry",
"id": "1-2",
"$type": "User"
},
"name": "New Scrum Project",
"id": "81-106",
"$type": "Project"
}Thanks for your feedback!