---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
  - property: og:type
    content: article
  - property: article:section
    content: Справочник API
  - property: og:title
    content: Получить параметры сущности
  - property: article:tag
    content: Техническая инструкция
alternate:
  - https://yandex.ru/support/tracker/en/api-ref/entities/get-entity.md
  - https://yandex.ru/support/tracker/ru/api-ref/entities/get-entity.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt


# Получить параметры сущности

Запрос позволяет получить информацию о сущности — [цели](*goal), [проекте](*project) или [портфеле проектов](*portfolio).

<div class="request_example method_get yfm-clipboard">
    <p>GET</p>
    <pre><code>https://api.tracker.yandex.net/v3/entities/&lt;тип_сущности>/&lt;id_сущности>?expand=attachments&fields=summary,teamAccess</code></pre>
    <button class="yfm-clipboard-button"><svg width="16" height="16" viewBox="0 0 24 24" class="yfm-clipboard-icon" data-animation="15">
    <path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path>
    <path stroke="currentColor" fill="transparent" strokewidth="1.5" d="M9.5 13l3 3l5 -5" visibility="hidden">
        <animate id="visibileAnimation-15" attributeName="visibility" from="hidden" to="visible" dur="0.2s" fill="freeze" begin=""></animate>
        <animate id="hideAnimation-15" attributeName="visibility" from="visible" to="hidden" dur="1s" begin="visibileAnimation-15.end+1" fill="freeze"></animate>
    </path>
</svg>
</button>
</div>

<!-- source: ru/api-ref/_assets/style/methods.md -->

<!-- endsource: ru/api-ref/_assets/style/methods.md -->

## Формат запроса {#query}

Перед выполнением запроса [получите доступ к API](https://yandex.ru/support/tracker/ru/api-ref/access.md).

Чтобы получить параметры сущности, используйте HTTP-запрос с методом `GET`.

```
GET /v3/entities/<тип_сущности>/<id_сущности>?expand=attachments&fields=summary,teamAccess
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
```

<!-- source: ru/api-ref/_includes/headings-no-body.md -->
{% cut "Заголовки" %}

* `Host`: адрес узла, предоставляющего API.

* <!-- source: ru/api-ref/_includes/authorization.md -->
  `Authorization`: токен для авторизации в одном из форматов:

    - `OAuth <OAuth-токен>` при авторизации по протоколу OAuth 2.0. [Читать подробнее](https://yandex.ru/support/tracker/ru/api-ref/access.md#about_OAuth)

    - `Bearer <IAM-токен>` при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. [Читать подробнее](https://yandex.ru/support/tracker/ru/api-ref/access.md#iam-token)
  <!-- endsource: ru/api-ref/_includes/authorization.md -->


* <!-- source: ru/api-ref/_includes/org-id.md -->
  `X-Org-ID` или `X-Cloud-Org-ID`: идентификатор организации.

  - если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок `X-Org-ID`,

  - если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок `X-Cloud-Org-ID`.
  <!-- endsource: ru/api-ref/_includes/org-id.md -->

  <!-- source: ru/api-ref/_includes/org-id.md -->
  Чтобы узнать идентификатор организации, перейдите на страницу **Администрирование** → [**Организации**](https://tracker.yandex.ru/admin/orgs) и скопируйте значение поля **идентификатор**.
  <!-- endsource: ru/api-ref/_includes/org-id.md -->


{% endcut %}
<!-- endsource: ru/api-ref/_includes/headings-no-body.md -->

<!-- source: ru/api-ref/_includes/resource-entity.md -->
{% cut "Ресурс" %}

Параметр | Описание | Тип данных
-------- | -------- | ----------
\<тип_сущности> | Тип сущности:<ul><li>project — проект;</li><li>portfolio — портфель;</li><li>goal — цель</li></ul>| Строка
\<id_сущности> | Идентификатор сущности. Чтобы получить идентификатор, посмотрите [список сущностей](search-entities.md). В качестве идентификатора можно использовать параметр `id` или `shortId`.| Строка

{% endcut %}
<!-- endsource: ru/api-ref/_includes/resource-entity.md -->

{% cut "Параметры запроса" %}

**Дополнительные параметры**

Параметр | Описание | Тип данных
-------- | -------- | ----------
fields |  Дополнительные поля сущности, которые будут включены в ответ. [Список допустимых полей](./about-entities.md#query-params)| Строка
expand | Дополнительная информация, которая будет включена в ответ:<ul><li>`attachments` – вложенные файлы.</li></ul> | Строка

{% endcut %}

> Пример: Получить информацию о портфеле
>
> - Используется HTTP-метод GET.
> - В ответе включено отображение вложений.
> - В ответ включено поле `teamAccess`.
>
> ```
> GET https://api.tracker.yandex.net/v3/entities/portfolio/655f328da834c763********?expand=attachments&fields=teamAccess
> ```

## Формат ответа {#answer}

{% list tabs %}

- Запрос выполнен успешно

   <!-- source: ru/api-ref/_includes/answer-200.md -->
   В случае успешного выполнения запроса API возвращает ответ с кодом `200 OK`.
   <!-- endsource: ru/api-ref/_includes/answer-200.md -->

   Тело ответа содержит информацию о сущности в формате JSON.

   ```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": "Имя Фамилия", "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": "api.tracker.yandex.net/v3/attachments/9/file2.pdf",
            "createdBy": { "self": "https://api.tracker.yandex.net/v3/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
            "createdAt": "2023-11-23T15:46:25.932+0000",
            "mimetype": "application/pdf",
            "size": 175656
         }
      ],
      "fields": {
        "summary": "Название проекта",
        "teamAccess": null,
        "author": { "self": "https://api.tracker.yandex.net/v3/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
        "parentEntity": {
            "primary": {
                "self": "https://api.tracker.yandex.net/v3/entities/portfolio/67ffd7e3********",
                "id": "67ffd7e3********",
                "display": "My portfolio"
            },
            "secondary": []
        }
      }

   }
   ```

   {% cut "Параметры ответа" %}

   Параметр | Описание | Тип данных
   -------- | -------- | ----------
   self | Адрес ресурса API, который содержит информацию о сущности. | Строка
   id | Идентификатор сущности. Идентификатор сущности не совпадает с идентификатором цели, проекта или портфеля в интерфейсе Трекера. | Строка
   version | Версия сущности. Каждое изменение параметров увеличивает номер версии. <br>Редактирование сущности будет заблокировано, если версия достигнет предельного значения: для роботов `10100`, для пользователей `11100`. | Число
   shortId | Идентификатор цели, проекта или портфеля в интерфейсе Трекера. | Число
   entityType | Тип сущности. | Строка
   createdBy | Блок с информацией о создателе сущности. | Объект
   createdAt | Дата создания сущности в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm`. | Строка
   updatedAt | Дата последнего обновления сущности в формате `YYYY-MM-DDThh:mm:ss.sss±hhmm`. | Строка
   attachments | Массив объектов с информацией о вложениях. | Массив объектов
   [fields](about-entities.md) | Блок с дополнительными полями сущности. | Объект

   **Поля объекта** `createdBy`

   <!-- source: ru/api-ref/_includes/user.md -->
   Параметр | Описание | Тип данных
   ----- | ----- | -----
   self | Адрес ресурса API, который содержит информацию о пользователе. | Строка
   id | Идентификатор пользователя. | Строка
   display | Отображаемое имя пользователя. | Строка
   passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число
   cloudUid | Уникальный идентификатор пользователя в Yandex Identity Hub. | Строка
   <!-- endsource: ru/api-ref/_includes/user.md -->

   {% endcut %}

- Запрос выполнен с ошибкой

   Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

   <!-- source: ru/api-ref/_includes/answer-error-400.md -->
   400
   :   Один или несколько параметров запроса имеют недопустимое значение.
   <!-- endsource: ru/api-ref/_includes/answer-error-400.md -->

   <!-- source: ru/api-ref/_includes/answer-error-401.md -->
   401
   :   Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе [Доступ к API](https://yandex.ru/support/tracker/ru/api-ref/access.md).
   <!-- endsource: ru/api-ref/_includes/answer-error-401.md -->

   <!-- source: ru/api-ref/_includes/answer-error-403.md -->
   403
   :   У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
   <!-- endsource: ru/api-ref/_includes/answer-error-403.md -->

   <!-- source: ru/api-ref/_includes/answer-error-404.md -->
   404
   :   Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
   <!-- endsource: ru/api-ref/_includes/answer-error-404.md -->

{% endlist %}

[*portfolio]: Портфель — это инструмент для объединения проектов и других портфелей по продукту, отделу или другому признаку.

Когда у вас несколько параллельных проектов, портфель позволяет взглянуть на них с высоты: как распределены ресурсы, где сроки подходят к концу.

[*project]: Проект — это набор задач из разных очередей, в которых работают над общим результатом. Это может быть запуск мобильного приложения или редизайн главной страницы сайта.

Проект помогает отслеживать: сколько задач сделано, сколько осталось, укладывается ли команда в сроки.

[*goal]: Цель — это стратегия развития или желаемый итог работы команды. Прогресс цели оценивают в количественных показателях. К цели можно привязать проекты, портфели и задачи, чтобы видеть, какая работа ведется для ее достижения.