---
metadata:
  - name: generator
    content: Diplodoc Platform v5.64.0
  - property: og:type
    content: article
  - property: article:section
    content: API reference
  - property: og:title
    content: Getting a widget
  - property: article:tag
    content: Technical instructions
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/en/api/dashboards/get-widget.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/support/tracker/en/llms.txt?revision=r21880163
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/en/llms.txt?revision=r21880163


# Getting a widget

Use this request to get widget parameters.

<div class="request_example yfm-code-floating-container method_get">
    <p>GET</p>
    <pre><code>https://api.tracker.yandex.net/v3/widgets/{widget_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: en/api/_assets/style/methods.md -->

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

## Query format {#query}

Before making a request, [get permission to access the API](https://yandex.ru/support/tracker/en/api/access.md).

To get widget parameters, use an HTTP `GET` request.

```json translate=no
GET /v3/widgets/{widget_id}
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID or X-Cloud-Org-ID: ORGANIZATION_ID
```

<!-- source: en/api/_includes/headings-no-body.md -->
{% cut "Headers" %}

* `Host`: address of the node that provides the API.

* <!-- source: en/api/_includes/authorization.md -->
  `Authorization`: Authorization token about these formats:

    - `OAuth OAUTH_TOKEN`: For authorization using the OAuth 2.0 protocol. [Learn more](https://yandex.ru/support/tracker/en/api/access.md#about_OAuth)

    - `Bearer IAM_TOKEN`: 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/access.md#iam-token)
  <!-- endsource: en/api/_includes/authorization.md -->


* <!-- source: en/api/_includes/org-id.md -->
  # ID types {#types}


  `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.


  # Finding the ID {#find-id}


  To get the organization ID, go to **Administration** → [**Organizations**](https://tracker.yandex.com/admin/orgs) and copy the value from the **ID** field.
  <!-- endsource: en/api/_includes/org-id.md -->


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

<!-- source: en/api/_includes/resource-widget-id.md -->
{% cut "Resource" %}

#|
|| **Parameter** | **Description** | **Data type** ||
|| widget_id | Widget ID. | Number ||
|#

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

## Response format {#answer}

{% list tabs %}

- Request executed successfully

    <!-- source: en/api/_includes/answer-200.md -->
    If the request is successful, the API returns a response with code `200 OK`.
    <!-- endsource: en/api/_includes/answer-200.md -->

    The response body contains a JSON object with widget parameters.

    The fields depend on the widget type. The example below shows a `filter` widget. Layout fields are returned when the widget is included in the dashboard layout.

    For supported widget types and their parameters, see [Query format](https://yandex.ru/support/tracker/en/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": "New dashboard"
        },
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v3/users/8000000000000007",
            "id": "11********",
            "display": "User Name",
            "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": "Issue",
                "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": "System"
                },
                "type": "standard"
            }
        ],
        "perPage": 10,
        "filterParams": {
            "filter": {
                "author": "Author"
            }
        }
    }
    ```

    {% cut "Response parameters" %}

    #|
    || **Parameter** | **Description** | **Data type** ||
    || id | Widget ID. | Number ||
    || version | Widget version. Each change to the widget increases the version number. | Number ||
    || type | Widget type. | String ||
    || self | URL of the API resource containing widget parameters. | String ||
    || [dashboard](#dashboard) | Object with information about the dashboard containing the widget. | Object ||
    || [createdBy](#user) | Object with information about the widget creator. | Object ||
    || description | Widget name. | String ||
    || text | Note text. Returned for `note` widgets. | String ||
    || column | Column number, if the widget is included in the layout. | Number ||
    || row | Row number, if the widget is included in the layout. | Number ||
    || collapsed | Whether the widget is collapsed, if specified in the layout. | Boolean ||
    || [coords](#coords-answer) | Position and size, if specified in the layout. | Object ||
    || order | Widget order, if specified in the layout. | Number ||
    || color | Service parameter. | Number ||
    || createdAt | Date and time when the widget was created, in the `YYYY-MM-DDThh:mm:ss.sss±hhmm` format. | String ||
    || [fields](#fields-answer) | Array of objects with information about the issue fields displayed in the widget. | Array of objects ||
    || perPage | Number of issues per widget page. | Number ||
    || [filterParams](#filterParams-answer) | Issue filtering parameters for the widget. | Object ||
    |#

    **Fields of the** `coords` **object** {#coords-answer}

    #|
    || **Parameter** | **Description** | **Data type** ||
    || x | Horizontal coordinate. | Number ||
    || y | Vertical coordinate. | Number ||
    || w | Width. | Number ||
    || h | Height. | Number ||
    |#

    **Object fields** `dashboard` {#dashboard}

    #|
    || **Parameter** | **Description** | **Data type** ||
    || self | URL of the API resource containing dashboard parameters. | String ||
    || id | Dashboard ID. | String ||
    || display | Dashboard name. | String ||
    |#

    **Object fields** `createdBy` {#user}

    <!-- source: en/api/_includes/user.md -->
    | 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 |
    <!-- endsource: en/api/_includes/user.md -->

    **Fields of elements in the** `fields` **array** {#fields-answer}

    #|
    || **Parameter** | **Description** | **Data type** ||
    || self | URL of the API resource containing field parameters. | String ||
    || id | Field ID. | String ||
    || name | Field name. | String ||
    || key | Field key. | String ||
    || version | Field version. | Number ||
    || [schema](#schema) | Field schema. | Object ||
    || readonly | Indicates that the field is read-only. | Boolean ||
    || options | Indicates that the field has a fixed set of values. | Boolean ||
    || suggest | Indicates that suggestions are available for the field. | Boolean ||
    || [queryProvider](#queryProvider) | Field query provider. | Object ||
    || order | Field display order. | Number ||
    || [category](#category) | Field category. | Object ||
    || type | Field type. | String ||
    |#

    **Object fields** `schema` {#schema}

    #|
    || **Parameter** | **Description** | **Data type** ||
    || type | Field data type. | String ||
    || required | Indicates that the field is required. | Boolean ||
    |#

    **Object fields** `queryProvider` {#queryProvider}

    #|
    || **Parameter** | **Description** | **Data type** ||
    || type | Query provider type. | String ||
    |#

    **Object fields** `category` {#category}

    #|
    || **Parameter** | **Description** | **Data type** ||
    || self | URL of the API resource containing category parameters. | String ||
    || id | Category ID. | String ||
    || display | Category name. | String ||
    |#

    **Object fields** `filterParams` {#filterParams-answer}

    #|
    || **Parameter** | **Description** | **Data type** ||
    || filter | Issue filter by parameters. | Object ||
    || query | Issue query, if specified. | String ||
    |#

    {% endcut %}

- Request failed

    If the request is processed incorrectly, the API returns a response with an error code:

    <!-- source: en/api/_includes/answer-error-400.md -->
    400
    :   One or more request parameters have an invalid value.
    <!-- endsource: en/api/_includes/answer-error-400.md -->

    <!-- source: en/api/_includes/answer-error-403.md -->
    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.
    <!-- endsource: en/api/_includes/answer-error-403.md -->

    <!-- source: en/api/_includes/answer-error-404.md -->
    404
    :   The requested object was not found. You may have specified an invalid object ID or key.
    <!-- endsource: en/api/_includes/answer-error-404.md -->

    <!-- source: en/api/_includes/answer-error-500.md -->
    500
    :   Internal service error. Try again later.
    <!-- endsource: en/api/_includes/answer-error-500.md -->

    <!-- source: en/api/_includes/answer-error-503.md -->
    503
    :   The API service is temporarily unavailable.
    <!-- endsource: en/api/_includes/answer-error-503.md -->

{% endlist %}