---
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 issue links with pagination
  - property: article:tag
    content: Technical reference
alternate:
  - https://yandex.com.tr/support/tracker/en/api/issues/get-links-paginate.md
  - href: https://yandex.com.tr/support/tracker/en/api/issues/get-links-paginate.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.com.tr/support/tracker/en/llms.txt?revision=r21483611
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/support/tracker/en/llms.txt?revision=r21483611


# Get issue links with pagination

Use this request to get a page from the issue link list with an HTTP `POST` request.

<div class="request_example yfm-code-floating-container method_post">
    <p>POST</p>
    <pre><code>https://api.tracker.yandex.net/v3/issues/{issue_id}/links/_list?page=PAGE&amp;perPage=ITEMS_PER_PAGE</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 -->

## Request format {#query}

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

To get a link list, use an HTTP `POST` request. Pass a JSON object in the request body:

```json
POST /v3/issues/{issue_id}/links/_list?page=PAGE&perPage=ITEMS_PER_PAGE
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
Content-Type: application/json
X-Org-ID or X-Cloud-Org-ID: ORGANIZATION_ID

{
    "fields": [],
    "linkTypes": [
        "relates"
    ]
}
```

<!-- source: en/api/_includes/headings.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.com.tr/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.com.tr/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.md -->

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

| Parameter | Description | Data type |
-------- | -------- | ----------
| `issue_key_or_ID` | ID or key of the current issue. | String |

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

{% cut "Query parameters" %}

| Parameter | Description | Data type |
| ----- | ----- | ----- |
| page | Response page number. | Number |
| perPage | Number of links per response page. | Number |

{% endcut %}

{% cut "Request body parameters" %}

| Parameter | Description | Data type |
| ----- | ----- | ----- |
| fields | Fields to include in the response. | String array |
| linkTypes | Link type IDs to include in the response. | String array |

{% endcut %}

> Example: Get an issue link list
>
> ```json
> POST https://api.tracker.yandex.net/v3/issues/JUNE-2/links/_list?page=1&perPage=20
> Content-Type: application/json
>
> {
>     "fields": [],
>     "linkTypes": ["relates"]
> }
> ```

## Response format {#answer}

{% list tabs %}

- Request completed 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 an object with the `links` array.

    ```json translate=no
    {
        "links": [
            {
                "self": "https://api.tracker.yandex.net/v3/issues/JUNE-2/links/47001",
                "id": 47001,
                "type": {
                    "self": "https://api.tracker.yandex.net/v3/linktypes/relates",
                    "id": "relates",
                    "inward": "relates",
                    "outward": "relates"
                },
                "direction": "outward",
                "object": {
                    "self": "https://api.tracker.yandex.net/v3/issues/TREK-9844",
                    "id": "593cd211ef7e8a33********",
                    "key": "TREK-9844",
                    "display": "Related issue"
                },
                "createdAt": "2017-06-11T05:16:01.421+0000",
                "updatedAt": "2017-06-11T05:16:01.421+0000"
            }
        ]
    }
    ```

    #### Response parameters {#response-parameters}

    Parameter | Description | Data type
    ----- | ----- | -----
    links | Array of issue link objects. | Array of objects

    **Fields of the `links` link object** {#link-fields}

    <!-- source: en/api/_includes/issue-links.md -->
    #|
    || Parameter | Description | Data type ||
    || self | Address of the API resource that contains information about the link | String ||
    || id | Link ID | Number ||
    || [type](#link-type) | Block with link type information | Object ||
    || direction | Type of relationship of the issue specified in the request relative to the issue in the `object` field. Possible values:
    * `outward` — the issue specified in the request is primary for the issue in the `object` field;
    * `inward` — the issue in the `object` field is primary for the issue specified in the request | String ||
    || [object](#issue) | Block with linked issue information | Object ||
    || [createdBy](#user) | Block with link creator information | Object ||
    || [updatedBy](#user) | Block with information about the last user who modified the linked issue | Object ||
    || createdAt | Date and time the link was created | String ||
    || updatedAt | Date and time the link was modified | String ||
    || [assignee](#user) | Assignee of the linked issue | Object ||
    || [status](#status) | Status of the linked issue | Object ||
    |#
    <!-- endsource: en/api/_includes/issue-links.md -->

    **Fields of the `type` object** {#link-type}

    <!-- source: en/api/_includes/issue-links.md -->
    Parameter | Description | Data type
    ----- | ----- | -----
    self | Link to the link type. | String
    id | Link type ID. | String
    inward | Name of the link type for the issue in the [object](#issue) field relative to the issue specified in the request. | String
    outward | Name of the link type for the issue specified in the request relative to the issue in the [object](#issue) field. | String
    <!-- endsource: en/api/_includes/issue-links.md -->

    **Fields of the `object` object** {#issue}

    <!-- source: en/api/_includes/issue.md -->
    | Parameter | Description | Data type |
    ----- | ----- | -----
    | self | Address of the API resource with information about the issue. | String |
    | id | Issue ID. | String |
    | key | Issue key. | String |
    | display | Issue name displayed. | String |
    <!-- endsource: en/api/_includes/issue.md -->

    **Fields of the `createdBy`, `updatedBy`, and `assignee` objects** {#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 the `status` object** {#status}

    <!-- source: en/api/_includes/status.md -->
    | Parameter | Description | Data type |
    ----- | ----- | -----
    | self | Address of the API resource with information about the status. | String |
    | id | Status ID. | String |
    | key | Status key. | String |
    | display | Status name displayed. | String |
    <!-- endsource: en/api/_includes/status.md -->

{% endlist %}