Projects

This root resource lets you manage projects and their settings.

Resource	`api/admin/projects`
Returned entity	Project. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: read a list of available projects. `POST`: create a new project.
Sub-resources	`api/admin/projects/<projectID>`: Operations with a specific project.

Supported Fields

This table describes attributes of the Project entity.

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

Field	Type	Description
archived	Boolean	When `true`, the project is archived. Otherwise, the project is active.
createdBy	User	Stores information about the user that created the project.
description	String?	Project description.
fields	ProjectCustomField	Stores a mutable collection of custom fields attached to the project.
fromEmail	String	Stores an email set as the "From" address in notifications about project issues.
iconUrl	String!	A URL to a project icon.
issues	Issue	Collection of issues in the project.
leader	User	Stores information about the user that is set as the project owner.
shortName	String?	Stores the project ID that is used as prefix in the issue IDs.
startingNumber	Long	Stores the number that is assigned to the first issue in the project.
id	String	Unique project entity identifier in YouTrack.
name	String?	Project name.

Read the Projects List

Get a list of available projects.

Request syntax

GET /api/admin/projects[?{fields}&{$skip}&{$top}]

Request parameters

Parameter	Type	Description
fields	string	A list of project attributes that should be returned in the response. If no fields specified, only entityID is returned.
$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 request:

curl -X GET \
'https://example.myjetbrains.com/youtrack/api/admin/projects?fields=id,name,shortName,createdBy%28login,name,id%29,leader%28login,name,id%29' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer perm:am9obi5kb2U=.UG9zdG1hbiBKb2huIERvZQ==.jJe0eYhhkV271j1lCpfknNYOEakNk7' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'

Sample response:

[
    {
        "description": "A sample project based on the default project template",
        "shortName": "SP",
        "leader": {
            "login": "root"
        },
        "createdBy": {
            "login": "root"
        },
        "name": "Sample Project",
        "id": "0-0"
    }
]

Create a New Project

Create a new project.

Request syntax:

POST /api/admin/projects[?{fields}]

Request parameters:

Parameter	Description
fields	Optional list of fields to return in the response.

To create a new project, send a POST request with the mandatory parameters shortName, name, and leader in the request body.

Sample request:

curl -X POST \
  'https://example.myjetbrains.com/youtrack/api/admin/projects?fields=id,shortName,name,leader%28id,login,name%29' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer perm:am9obi5kb2U=.UG9zdG1hbiBKb2huIERvZQ==.jJe0eYhhkV271j1lCpfknNYOEakNk7' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{
	"description": "A new project created from rest api",
	"name": "GRA Project",
	"shortName": "GRP",
	"leader":{
		"id":"1-2"
	}
}'

Sample response body:

{
    "shortName": "GRP",
    "leader": {
        "login": "john.doe",
        "name": "John Doe",
        "id": "1-2"
    },
    "name": "GRA Project",
    "id": "0-7"
}

Last modified: 8 March 2019