Get a list of all projects
Use this request to get a list of all organization projects.
You can also use the new, more flexible and functional getting entity list API that provides a unified method for getting a list of projects and portfolios.
Request format
Before making the request, get permission to access the API.
To get a list of projects, use an HTTP GET request.
GET /v2/projects
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>
Headers
-
Host
Address of the node that provides the API:
https://api.tracker.yandex.net -
Authorization
OAuth token in
OAuth <OAuth_token>format, e.g.:OAuth 0c4181a7c2cf4521964a72ff******** -
X-Org-ID or X-Cloud-Org-ID
Organization ID. You can find it out on the Tracker organizations page.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
X-Org-IDheader is used. - If a Yandex Cloud Organization organization is the only one linked to Tracker, the
X-Cloud-Org-IDheader is used. - If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the
X-Org-IDheader and the Yandex 360 for Business organization ID are used.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
Request parameters
Additional parameters
| Parameter | Description | Data type |
|---|---|---|
| expand | Additional fields to include in the response:
|
String |
Response format
If the request is successful, the API returns a response with code 200 OK.
The response body contains information about all the organization's projects in JSON format.
{
"self": "https://https://api.tracker.yandex.net/v2/projects/1",
"id": "1",
"version": 1,
"key": "Project 1",
"name": "Project 1",
"description": "First project",
"lead": {
"self": "https://https://api.tracker.yandex.net/v2/users/12********",
"id": "12********",
"display": "Full Name"
},
"status": "launched",
"startDate": "2020-11-01",
"endDate": "2020-12-01"
},
{
"self": "https://https://api.tracker.yandex.net/v2/projects/2",
"id": "2",
"version": 1,
"key": "Project 2",
"name": "Project 2",
"description": "Another project",
"lead": {
"self": "https://https://api.tracker.yandex.net/v2/users/12********",
"id": "12********",
"display": "Full Name"
},
"status": "launched",
"startDate": "2020-11-02",
"endDate": "2020-12-02"
},
{
...
},
{
...
}
Response parameters
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the project. | String |
| id | Project ID. | Number |
| version | Project version. Each change of the parameters increases the version number. | Number |
| key | Project key. Matches the project name. | String |
| name | Project name | String |
| description | Project description. This parameter is not displayed in the Tracker interface. | String |
| lead | Block with information about the project assignee | Object |
| status | Stage of the project:
|
String |
| startDate | Project start date in YYYY-MM-DD format |
String |
| endDate | Project end date in YYYY-MM-DD format |
String |
lead object fields
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the user. | String |
| id | User ID. | Number |
| display | Displayed user name. | String |
If the request is processed incorrectly, the API returns a response with an error code:
- 400
- One or more request parameters have an invalid value.
- 401
- The user isn't authorized. Make sure to perform the actions described in API access.
- 403
- Insufficient rights to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.