Projects
This resource provides access to projects.
Resource | /api/admin/projects |
Returned entity | Project. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Supported sub-resources |
|
Project attributes
Represents a YouTrack project.
Extends IssueFolder
This table describes attributes of the Project
entity.
To receive an attribute in the response from server, specify it explicitly in the request parameter
fields
.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
---|---|---|
startingNumber | Long | Starting number for issues in project. This property can be set only during creation of the new project. |
shortName | String | The ID of the project. This short name is also a prefix for an issue ID. |
description | String | The description of the project as shown on the project profile page. |
leader | User | The user who is set as the project lead. |
createdBy | User | The user who created the project. |
issues | Array of Issues | A list of all issues that belong to the project. |
customFields | ProjectCustomField | The set of custom fields that are available in the project. |
archived | Boolean | If the project is currently archived, this property is `true`. |
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. |
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. |
template | Boolean | If |
iconUrl | String | The URL of the icon of the project. |
name | String | The name of the issue folder. |
Read a List of Projects
Get a list of all available projects in the system.
Request syntax
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 |
$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. |
Sample
Sample request URI
Sample response body
Add a New Project
When creating a new project, you must provide project's name, short name, and the project leader. Other attributes are optional. To create a project that is based on a template, like Scrum or Kanban, you need to add template
query parameter to the endpoint URL.
Required permissions
Requires Create Project permission.
Request syntax
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 |
template | String | If the |
Sample 1
This sample shows a minimal viable request to create a new project.
Sample request URI
Sample request body
Sample response body
Sample 2
This sample shows a request to create a new project with the Scrum template.