## Query format {#query}
Before making a request, [get permission to access the API](https://yandex.ru/support/tracker/en/api-ref/access.md).
To get entity parameters, use an HTTP `GET` request.
```
GET /v3/entities//?expand=attachments&fields=summary,teamAccess
Host: api.tracker.yandex.net
Authorization: OAuth
X-Org-ID or X-Cloud-Org-ID:
```
{% cut "Headers" %}
* `Host`: address of the node that provides the API.
*
`Authorization`: Authorization token about these formats:
- `OAuth `: For authorization using the OAuth 2.0 protocol. [Learn more](https://yandex.ru/support/tracker/en/api-ref/access.md#about_OAuth)
- `Bearer `: For authorization using an IAM token, if a Yandex Identity Hub organization is linked to Tracker. [Learn more](https://yandex.ru/support/tracker/en/api-ref/access.md#iam-token)
*
`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 Identity Hub.
To get the organization ID, go to **Administration** → [**Organizations**](https://tracker.yandex.com/admin/orgs) and copy the value from the **ID** field. {#find-id}
{% endcut %}
{% cut "Resource" %}
| Parameter | Description | Data type |
-------- | -------- | ----------
| \ | Entity type:
project
portfolio
goal
| String |
| \ | Entity ID. To get the ID, see the [entity list](search-entities.md). You can use the `id` or `shortId` parameter as the ID. | String |
{% endcut %}
{% cut "Request parameters" %}
**Additional parameters**
| Parameter | Description | Data type |
-------- | -------- | ----------
| fields | Additional entity fields to include in the response [Supported fields](./about-entities.md#query-params) | String |
| expand | Additional information to include in the response:
`attachments`: Attached files
| String |
{% endcut %}
> Example: Getting information about a portfolio
>
> - An HTTP GET method is used.
> - The response will display attachments.
> - The response will include the `teamAccess` field.
>
> ```
> GET https://api.tracker.yandex.net/v3/entities/portfolio/655f328da834c763********?expand=attachments&fields=teamAccess
> ```
## Response format {#answer}
{% list tabs %}
- Request executed successfully
If the request is successful, the API returns a response with code `200 OK`.
The response body contains information about the entity in JSON format.
```json translate=no
{
"self": "https://api.tracker.yandex.net/v3/entities/project/655f328da********",
"id": "655f328da********",
"version": 3,
"shortId": 2,
"entityType": "project",
"createdBy": { "self": "https://api.tracker.yandex.net/v3/users/11********", "id": "11********", "display": "User Name", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
"createdAt": "2023-11-23T11:07:57.298+0000",
"updatedAt": "2023-11-23T15:46:26.391+0000",
"attachments": [
{
"self": "https://api.tracker.yandex.net/v3/attachments/9",
"id": "9",
"name": "file2.pdf",
"content": "https://api.tracker.yandex.net/v3/attachments/9/file2.pdf",
"createdBy": { "self": "https://api.tracker.yandex.net/v3/users/11********", "id": "11********", "display": "User Name", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
"createdAt": "2023-11-23T15:46:25.932+0000",
"mimetype": "application/pdf",
"size": 175656
}
],
"fields": {
"summary": "Project name",
"teamAccess": null,
"author": { "self": "https://api.tracker.yandex.net/v3/users/11********", "id": "11********", "display": "User Name", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
"parentEntity": {
"primary": {
"self": "https://api.tracker.yandex.net/v3/entities/portfolio/67ffd7e3********",
"id": "67ffd7e3********",
"display": "My portfolio"
},
"secondary": []
}
}
}
```
{% cut "Response parameters" %}
| Parameter | Description | Data type |
-------- | -------- | ----------
| self | Address of the API resource with information about the entity | String |
| id | Entity ID. Entity ID is not the same as goal, project, or portfolio ID in the Yandex Tracker interface. | String |
| version | Entity version. Each change of the parameters increases the version number. Entity edits will be disabled if the version number reaches the threshold value of `10100` (for robots) or `11100` (for users). | Number |
| shortId | Goal, project, or portfolio ID in Yandex Tracker. | Number |
| entityType | Entity type | String |
| createdBy | Block with information about the entity creator | Map object |
| createdAt | Entity creation date in `YYYY-MM-DDThh:mm:ss.sss±hhmm` format | String |
| updatedAt | Date when the entity was last updated, in `YYYY-MM-DDThh:mm:ss.sss±hhmm` format | String |
| attachments | Object array with information about attachments. | Array of objects |
| [fields](about-entities.md) | Block with additional entity fields. | Map object |
`createdBy` **object 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 Identity Hub | String |
{% endcut %}
- Request failed
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](https://yandex.ru/support/tracker/en/api-ref/access.md) 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.
{% endlist %}