Get queue components

Use this request to get a list of queue components.

GET

https://api.tracker.yandex.net/v3/queues/{queue_ID}/components?fields=id,name,queue

Query format

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

To get queue components, use an HTTP GET request.

GET /v3/queues/{queue_ID}/components?fields=id,name,queue
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
queue_ID Queue ID or key. The key is case-sensitive. String or number
Request parameters
Parameter Description Data type
fields Comma-separated list of fields to return: version, name, queue, description, lead, assignAuto. The self and id fields are always returned. String

Response format

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

The response body contains a JSON array of components.

[
    {
        "self": "https://api.tracker.yandex.net/v3/components/123",
        "id": 123,
        "name": "Component",
        "queue": {
            "self": "https://api.tracker.yandex.net/v3/queues/TEST",
            "id": "1",
            "key": "TEST",
            "display": "Test queue"
        }
    }
]
Component object parameters
Parameter Description Data type
self Link to the component object. String
id Component ID. Number
name Component name. String
queue Queue that contains the component. Map item

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
Previous
Get a list of components
Next
Get a component