---
metadata:
  - name: generator
    content: Diplodoc Platform v5.63.0
  - property: og:type
    content: article
  - property: article:section
    content: API reference
  - property: og:title
    content: Get a component
  - property: article:tag
    content: Technical guide
alternate:
  - https://yandex.ru/support/tracker/en/api/queues/get-component.md
  - https://yandex.ru/support/tracker/ru/api/queues/get-component.md
  - href: https://yandex.ru/support/tracker/en/api/queues/get-component.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/support/tracker/en/llms.txt
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/en/llms.txt


# Get a component

Use this request to get [component](https://yandex.ru/support/tracker/en/manager/components.md) parameters.

<div class="request_example yfm-code-floating-container method_get">
    <p>GET</p>
    <pre><code>https://api.tracker.yandex.net/v3/components/{component_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 a component, use an HTTP `GET` request.

```http
GET /v3/components/{component_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 -->

{% cut "Resource" %}

| Parameter | Description | Data type |
----- | ----- | -----
| `component_ID` | Component ID. | Number |

{% endcut %}

{% cut "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 |

{% endcut %}

If you pass the `ETag` value from a previous response in the `If-None-Match` header and the component has not changed, the API returns `304` without a response body.

## 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 component parameters.

    ```json
    {
        "self": "https://api.tracker.yandex.net/v3/components/123",
        "id": 123,
        "version": 1,
        "name": "Component",
        "description": "Component description",
        "queue": {
            "self": "https://api.tracker.yandex.net/v3/queues/TEST",
            "id": "1",
            "key": "TEST",
            "display": "Test queue"
        },
        "lead": {
            "self": "https://api.tracker.yandex.net/v3/users/11********",
            "id": "11********",
            "display": "User Name"
        },
        "assignAuto": false
    }
    ```

    {% cut "Response parameters" %}

    | Parameter | Description | Data type |
    ----- | ----- | -----
    | self | Link to the component object. | String |
    | id | Component ID. | Number |
    | version | Component version. | Number |
    | name | Component name. | String |
    | description | Component description. | String |
    | [queue](#queue) | Queue that contains the component. | Map item |
    | [lead](#lead) | Component owner. | Map item |
    | assignAuto | Whether to automatically assign the component owner as the assignee. | Boolean |

    `queue` **object fields** {#queue}

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

    `lead` **object fields** {#lead}

    <!-- 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 -->

    {% endcut %}

- Request failed

    If the component is not found, the API returns the following error code:

    <!-- 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 -->

{% endlist %}