Getting a widget

Use this request to get widget parameters.

GET

https://api.tracker.yandex.net/v3/widgets/{widget_id}

Query format

Before making a request, get permission to access the API.

To get widget parameters, use an HTTP GET request.

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

Headers

Host: address of the node that provides the API.
Authorization: Authorization token about these formats:
- OAuth OAUTH_TOKEN: For authorization using the OAuth 2.0 protocol. Learn more
- Bearer IAM_TOKEN: For authorization using an IAM token, if a Yandex Identity Hub organization is linked to Tracker. Learn more
ID 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

To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Resource

Parameter	Description	Data type
widget_id	Widget ID.	Number

Response format

Request executed successfully

Request failed

If the request is successful, the API returns a response with code 200 OK.

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.

{
    "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"
        }
    }
}

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	Object with information about the dashboard containing the widget.	Object
createdBy	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	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	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	Issue filtering parameters for the widget.	Object

Fields of the coords object

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

Object fields 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

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

Fields of elements in the fields array

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	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	Field query provider.	Object
order	Field display order.	Number
category	Field category.	Object
type	Field type.	String

Object fields schema

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

Object fields queryProvider

Parameter	Description	Data type
type	Query provider type.	String

Object fields 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

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

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.

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.

500: Internal service error. Try again later.

503: The API service is temporarily unavailable.

Was the article helpful?

Create a widget

Update a widget

Getting a widget

Query format

ID types

Finding the ID

Response format

Was the article helpful?