Contact UsGet started

Getting issue links

Written by
Updated at February 19, 2024

Use this request to get information about issue links. The issue is selected when its ID or key is specified.

Request format

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

To get a list of issue links, use an HTTP GET request:

GET /v2/issues/<issue_ID_or_key>/links
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
Headers

  • Host

    Address of the node that provides the API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth token in OAuth <OAuth_token> format, e.g.:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID or X-Cloud-Org-ID

    Organization ID. You can find it out on the Tracker organizations page.

    • If a Yandex 360 for Business organization is the only one linked to Tracker, the X-Org-ID header is used.
    • If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
    • If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.
Resource
Parameter Description Data type
<issue_key_or_ID> ID or key of the current issue. String

Request for issue links:

  • An HTTP GET method is used.
GET /v2/issues/JUNE-2/links HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>

Response format

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

The response body contains the results in JSON format.

[
    {
        "self": "https://https://api.tracker.yandex.net/v2/issues/JUNE-2/links/47*****",
        "id": 47*****,
        "type": {
            "self": "https://https://api.tracker.yandex.net/v2/linktypes/subtask",
            "id": "subtask",
            "inward": "Subissue",
            "outward": "Parent issue"
        },
        "direction": "outward",
        "object": {
            "self": "https://https://api.tracker.yandex.net/v2/issues/TREK-9844",
            "id": "593cd211ef7e8a33********",
            "key": "TREK-9844",
            "display": "subtask"
        },
        "createdBy": {
            "self": "https://https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Ivan Ivanov"
        },
        "updatedBy": {
            "self": "https://https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Ivan Ivanov"
        },
        "createdAt": "2017-06-11T05:16:01.421+0000",
        "updatedAt": "2017-06-11T05:16:01.421+0000",
        "assignee": {
            "self": "https://https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Ivan Ivanov"
        },
        "status": {
            "self": "https://https://api.tracker.yandex.net/v2/statuses/1",
            "id": "1",
            "key": "open",
            "display": "Open"
        }
    },
    ...
]

Response parameters

Parameter Description Data type
self Address of the API resource with information about the link. String
id Link ID. Number
type Block with information about the link type. Object
direction Link type of the issue specified in the request in relation to the issue specified in the object field. Possible values:
  • outward: The issue specified in the request is the main one for the issue in the object field.
  • inward: The issue specified in the object field is the main one for the issue in the request.
 String
object Block with information about the linked issue. Object
createdBy Block with information about the user who created the link. Object
updatedBy Block with information about the user who edited the linked issue last. Object
createdAt Link creation date and time. String
updatedAt Link update date and time. String
assignee Assignee of the linked issue. Object
status Status of the linked issue. Object

Object fields type

Parameter Description Data type
self Link to the link type. String
id ID of the link type. String
inward Name of the link type of the issue specified in the object field in relation to the issue specified in the request. String
outward Name of the link type of the issue specified in the request in relation to the issue specified in the object field. String

object object fields

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

Object fields createdBy

Parameter Description Data type
self Address of the API resource with information about the user. String
id User ID. String
display User's name displayed. String

Object fields updatedBy

Parameter Description Data type
self Address of the API resource with information about the user. String
id User ID. String
display User's name displayed. String

Object fields assignee

Parameter Description Data type
self Address of the API resource with information about the user. String
id User ID. String
display User's name displayed. String

Object fields status

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

If the request is processed incorrectly, the API returns a response with an error code:

404
The requested object was not found. You may have specified an invalid object ID or key.
Previous
Linking issues
Next
Deleting a link with an issue