Getting a list of components

The request enables you to get a list of all the components created by the organization users.

GET

https://api.tracker.yandex.net/v3/components

Query format

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

To get all the components, use an HTTP GET request:

GET /v3/components
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_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 Cloud Organization organization is linked to Tracker. Learn more

  • 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 Cloud Organization.

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

Response format

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

The response body contains a JSON array with parameters for all components created by the organization's users.

[
  {
    "self": "https://api.tracker.yandex.net/v3/components/1",
    "id": 1,
    "version": 3,
    "name": "Test",
    "queue": {
        "self": "https://api.tracker.yandex.net/v3/queues/ORG",
        "id": "1",
        "key": "ORG",
        "display": "Organization"
    },
    "description": "<component_description>",
    "lead": {
           "self": "https://api.tracker.yandex.net/v3/users/11********",
           "id": "11********",
           "display": "Ivan Ivanov"
        },
    "assignAuto": false
  },
...
]
Response parameters
Parameter Description Data type
self Links to component String
id Component ID. Number
version Component version. Each change to the component increases the version number. Number
name Component name. String
queue Object with information about the queue component. Map item
description Text description of the component. String
lead Block with information about the component owner. Map item
assignAuto Assign all the new issues with this component to the component's owner automatically:
  • true: Assign
  • false: Do not assign
 Boolean

queue object fields

Parameter Description Data type
self Address of the API resource with information about the queue. String
id Queue ID. String
key Queue key. String
display Queue name displayed. String

lead 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 Cloud Organization 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.
401
The user is not authorized. Make sure that actions described in the API access 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.
500
Internal service error. Try again later.
503
The API service is temporarily unavailable.
Previous
Create a widget
Next
Creating a component