Projects, portfolios, and goals

The Entities API presents a unified set of methods for goal, project, or portfolio management with enhanced flexibility and functionality.

With this API, you can:

Additional entity parameters

The request body for managing entities and responses to requests may contain the fields object with additional entity parameters. See all allowed fields of the fields object in the table below.

To edit entity parameters, you can use the set, add, remove, and other operators. For more information, see Editing parameters.

To include additional parameters in the response body, add the fields parameter to the request address and specify one or more values.

For example, you can configure the response to include a project description and details of the checklist items.

POST https://api.tracker.yandex.net/v3/entities/<entity_type>/<entity_ID>/checklistItems?fields=description,checklistItems

The response body will include a fields object with the requested information.

Field

Description

Data type

Entity type

summary

Entity name

String

Project
Portfolio
Goal

description

Entity description

String

Project
Portfolio
Goal

author

Author

Object

Project
Portfolio
Goal

lead

Lead

Object

Project
Portfolio
Goal

teamUsers

Participants

Object array

Project
Portfolio
Goal

clients

Customers

Object array

Project
Portfolio
Goal

followers

Followers

Object array

Project
Portfolio
Goal

start

Start date in YYYY-MM-DD format

String

Project
Portfolio

end

Deadline in YYYY-MM-DD format

String

Project
Portfolio
Goal

checklistItems

Checklist (for projects and portfolios) or a list of key results (for goals)

Object

Project
Portfolio
Goal

tags

Tags

String array

Project
Portfolio
Goal

parentEntity

Parent entity data. For a project or portfolio: "Included in the portfolio" field

Object

Project
Portfolio
Goal

teamAccess

Access settings:

  • true: Only project, portfolio, or goal participants have access
  • false: Users who aren't project, portfolio, or goal participants have access

String

Project
Portfolio
Goal

quarter

Project start and end quarters in 2025 Q1 format

String array

Project
Portfolio

entityStatus

Status

For projects or portfolios:

  • draft: New.
  • draft2: Draft.
  • in_progress: In progress.
  • according_to_plan: As planned.
  • postponed: Postponed.
  • at_risk: At risk.
  • blocked: Blocked.
  • launched: Finished.
  • cancelled: Canceled.

For goals:

  • draft: New.
  • according_to_plan: As planned.
  • at_risk: At risk.
  • blocked: Blocked.
  • achieved: Completed.
  • partially_achieved: Partially completed.
  • not_achieved: Not completed.
  • exceeded: Exceeded.
  • cancelled: Canceled.

String

Project
Portfolio
Goal

issueQueues

Issue queues

Object array

Project

Fields of objects that contain user data

The author, lead, teamUsers, clients, and followers entity parameters contain objects with the following fields:

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Cloud Organization String

checklistItems object fields

Parameter Description Data type
id hecklist item ID. String
text Text of the checklist item. String
textHtml Text of the checklist item in HTML format. String
checked Checklist item completion flag:
  • true: Item marked as completed.
  • false: Item not marked as completed.
 Boolean
assignee Assignee of the checklist item. Map item
deadline Deadline for the checklist item. Map item
checklistItemType Type of the checklist item. String

parentEntity object fields

Parameter Description Data type
primary The main portfolio (for projects and portfolios) or parent goal (for goals) Object
secondary For projects and portfolios: a list of additional portfolios
For goals, the parameter value is always empty		 Array of objects

If the request address specifies the API v2, the parentEntity object contains information only about the main portfolio or parent goal.

Fields of the object that contains entity data

The primary and secondary parameters contain objects with the following fields:

Parameter Description Data type
self Address of the API resource with information about the entity String
id Entity ID String
display Entity name String

issueQueues object fields

Parameter Description Data type
self Address of the API resource with information about the queue. String
id Queue ID. String
key Queue key. String
display Queue name displayed. String
Previous
Editing a local queue field
Next
Creating an entity