---
metadata:
  - name: generator
    content: Diplodoc Platform v5.64.0
  - 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/dashboards/get-widget.md
  - https://yandex.ru/support/tracker/ru/api/dashboards/get-widget.md
  - href: https://yandex.ru/support/tracker/ru/api/dashboards/get-widget.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/support/tracker/ru/llms.txt?revision=r21825371
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt?revision=r21825371


# Получить виджет

Запрос позволяет получить параметры виджета.

<div class="request_example yfm-code-floating-container method_get">
    <p>GET</p>
    <pre><code>https://api.tracker.yandex.net/v3/widgets/{id_виджета}</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/_assets/style/methods.md -->

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

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

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

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

```json translate=no
GET /v3/widgets/{id_виджета}
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ
```

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

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

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

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

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


* <!-- source: ru/api/_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/_includes/org-id.md -->

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


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

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

#|
|| **Параметр** | **Описание** | **Тип данных** ||
|| id_виджета | Идентификатор виджета. | Число ||
|#

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

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

{% list tabs %}

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

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

    Тело ответа содержит JSON-объект с параметрами виджета.

    Набор полей зависит от типа виджета. Ниже приведен пример ответа для `filter`. Поля раскладки возвращаются, если виджет размещен на дашборде.

    Поддерживаемые типы виджетов и их параметры описаны в разделе [Формат запроса](https://yandex.ru/support/tracker/ru/api/dashboards/create-dashboard-widget.md#query).

    ```json translate=no
    {
        "id": 123456,
        "version": 1,
        "type": "filter",
        "self": "https://api.tracker.yandex.net/v3/widgets/123456",
        "column": 1,
        "row": 1,
        "coords": {"x": 0, "y": 0, "w": 6, "h": 8},
        "dashboard": {
            "self": "https://api.tracker.yandex.net/v3/dashboards/18",
            "id": "18",
            "display": "Новый дашборд"
        },
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v3/users/8000000000000007",
            "id": "11********",
            "display": "Имя Фамилия",
            "cloudUid": "ajeppa7dgp53********",
            "passportUid": 1100000000000000
        },
        "description": "new desc",
        "color": 0,
        "createdAt": "2026-08-27T10:34:30.363+0000",
        "fields": [
            {
                "self": "https://api.tracker.yandex.net/v3/fields/summary",
                "id": "summary",
                "name": "Задача",
                "key": "summary",
                "version": 0,
                "schema": {
                    "type": "string",
                    "required": true
                },
                "readonly": false,
                "options": false,
                "suggest": false,
                "queryProvider": {
                    "type": "SummaryQueryProvider"
                },
                "order": 6,
                "category": {
                    "self": "https://api.tracker.yandex.net/v3/fields/categories/000000000000000000000001",
                    "id": "000000000000000000000001",
                    "display": "Системные"
                },
                "type": "standard"
            }
        ],
        "perPage": 10,
        "filterParams": {
            "filter": {
                "author": "Автор"
            }
        }
    }
    ```

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

    #|
    || **Параметр** | **Описание** | **Тип данных** ||
    || id | Идентификатор виджета. | Число ||
    || version | Версия виджета. Каждое изменение виджета увеличивает номер версии. | Число ||
    || type | Тип виджета. | Строка ||
    || self | Адрес ресурса API, который содержит параметры виджета. | Строка ||
    || [dashboard](#dashboard) | Объект с информацией о дашборде, на котором размещен виджет. | Объект ||
    || [createdBy](#user) | Объект с информацией о создателе виджета. | Объект ||
    || description | Название виджета. | Строка ||
    || text | Текст заметки. Возвращается для виджета `note`. | Строка ||
    || column | Номер колонки, если виджет размещен в раскладке. | Число ||
    || row | Номер строки, если виджет размещен в раскладке. | Число ||
    || collapsed | Признак свернутого виджета, если он задан в раскладке. | Логический ||
    || [coords](#coords-answer) | Координаты и размер, если они заданы в раскладке. | Объект ||
    || order | Порядок виджета, если он задан в раскладке. | Число ||
    || color | Служебный параметр. | Число ||
    || createdAt | Дата и время создания виджета в формате ```YYYY-MM-DDThh:mm:ss.sss±hhmm```. | Строка ||
    || [fields](#fields-answer) | Массив объектов с информацией о полях задач, отображаемых в виджете. | Массив объектов ||
    || perPage | Количество задач на одной странице виджета. | Число ||
    || [filterParams](#filterParams-answer) | Параметры фильтрации задач для виджета. | Объект ||
    |#

    **Поля объекта** `coords` {#coords-answer}

    #|
    || **Параметр** | **Описание** | **Тип данных** ||
    || x | Координата по горизонтали. | Число ||
    || y | Координата по вертикали. | Число ||
    || w | Ширина. | Число ||
    || h | Высота. | Число ||
    |#

    **Поля объекта** `dashboard` {#dashboard}

    #|
    || **Параметр** | **Описание** | **Тип данных** ||
    || self | Адрес ресурса API, который содержит параметры дашборда. | Строка ||
    || id | Идентификатор дашборда. | Строка ||
    || display | Название дашборда. | Строка ||
    |#

     **Поля объекта** `createdBy` {#user}

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

    **Поля элементов массива** `fields` {#fields-answer}

    #|
    || **Параметр** | **Описание** | **Тип данных** ||
    || self | Адрес ресурса API, который содержит параметры поля. | Строка ||
    || id | Идентификатор поля. | Строка ||
    || name | Название поля. | Строка ||
    || key | Ключ поля. | Строка ||
    || version | Версия поля. | Число ||
    || [schema](#schema) | Схема поля. | Объект ||
    || readonly | Признак того, что поле доступно только для чтения. | Логический ||
    || options | Признак того, что поле имеет фиксированный набор значений. | Логический ||
    || suggest | Признак того, что для поля доступны подсказки. | Логический ||
    || [queryProvider](#queryProvider) | Провайдер запросов для поля. | Объект ||
    || order | Порядок отображения поля. | Число ||
    || [category](#category) | Категория поля. | Объект ||
    || type | Тип поля. | Строка ||
    |#

    **Поля объекта** `schema` {#schema}

    #|
    || **Параметр** | **Описание** | **Тип данных** ||
    || type | Тип данных поля. | Строка ||
    || required | Признак того, что поле обязательно для заполнения. | Логический ||
    |#

    **Поля объекта** `queryProvider` {#queryProvider}

    #|
    || **Параметр** | **Описание** | **Тип данных** ||
    || type | Тип провайдера запросов. | Строка ||
    |#

    **Поля объекта** `category` {#category}

    #|
    || **Параметр** | **Описание** | **Тип данных** ||
    || self | Адрес ресурса API, который содержит параметры категории. | Строка ||
    || id | Идентификатор категории. | Строка ||
    || display | Название категории. | Строка ||
    |#

    **Поля объекта** `filterParams` {#filterParams-answer}

    #|
    || **Параметр** | **Описание** | **Тип данных** ||
    || filter | Фильтр задач по параметрам. | Объект ||
    || query | Фильтр задач на языке запросов, если он задан. | Строка ||
    |#

    {% endcut %}

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

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

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

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

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

    <!-- source: ru/api/_includes/answer-error-500.md -->
    500
    :   Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
    <!-- endsource: ru/api/_includes/answer-error-500.md -->

    <!-- source: ru/api/_includes/answer-error-503.md -->
    503
    :   Сервис API временно недоступен.    
    <!-- endsource: ru/api/_includes/answer-error-503.md -->

{% endlist %}