Getting project parameters

Use this request to get information about a project.

GET

https://api.tracker.yandex.net/v3/projects/<project_ID>

You can also use the new, more flexible get entity information API that provides a unified method for getting information about projects and portfolios.

Query format

Before making a request, get permission to access the API.

To get project parameters, use an HTTP GET request.

GET /v3/projects/<project_ID>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
Headers

  • Host: Address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more

  • X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.

    To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Resource

Resource

Parameter Description Data type
<project_ID> Project ID Number
Request parameters

Additional parameters

Parameter Description Data type
expand Additional fields to include in the response:
  • queues: Project queues
String

Response format

If the request is successful, the API returns a response with code 200 OK.

The response body contains information about the project in JSON format.

{
    "self": "https://api.tracker.yandex.net/v3/projects/9",
    "id": "9",
    "version": 1,
    "key": "Project",
    "name": "Project",
    "description": "New project",
    "lead": {
        "self": "https://api.tracker.yandex.net/v3/users/12********",
        "id": "12********",
        "display": "Full name"
    },
    "status": "launched",
    "startDate": "2020-11-16",
    "endDate": "2020-12-16"
}
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 Map item
status Stage of the project:
  • DRAFT: Draft
  • IN_PROGRESS: In progress
  • LAUNCHED: Launched
  • POSTPONED: Postponed
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 User's display 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 is not authorized. Make sure that actions described in the API access section are performed.
403
You are not authorized 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.
404
The requested object was not found. You may have specified an invalid object ID or key.
Previous
Creating a project
Next
Get a list of all projects