Projects and portfolios. Overview
Written by
Updated at February 19, 2024
The Entities API presents a unified set of methods for project and portfolio management, more flexible and functional than the project management API.
With this API, you can:
- Create, edit, and delete projects and portfolios.
- Get information about projects and portfolios.
- Search for and make bulk changes to projects and portfolios.
- Create, edit, and delete checklists.
- Edit, move, and delete individual checklist items.
Request parameters
You can use request parameters to include additional information in the response body.
In the query fields parameter, specify one or more values:
| Field | Description |
|---|---|
| summary | Entity name |
| description | Entity description |
| author | Author (user ID) |
| lead | Responsible person (user ID) |
| teamUsers | Participants (array of user IDs) |
| clients | Customers (array of user IDs) |
| followers | Followers (array of user IDs) |
| start | Start Date |
| end | Deadline |
| checklistItems | Checklists |
| tags | Tags |
| parentEntity | Parent entity (portfolio) ID |
| teamAccess | Access |
| quarter | Project start and end quarters |
| entityStatus | Status |
| issueQueues | Issue queues within the project |
For example, you can configure the response to include a project description and checklist items information:
POST /v2/entities/<entity_type>/<entity_ID>/checklistItems?fields=description&fields=checklistItems
The response body will include the requested information in JSON format.