---
title: "Get remote issue links"
method: GET
path: "/rest/api/3/issue/{issueIdOrKey}/remotelink"
tags: ["Issue remote links"]
---

# Get remote issue links

`GET /rest/api/3/issue/{issueIdOrKey}/remotelink`

Returns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For example, pass `system=http://www.mycompany.com/support&id=1` as `system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1`.

This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

 *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
 *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.

## Path parameters

- `issueIdOrKey` string, required

## Query parameters

- `globalId` string

## Response `200`

Returned if the request is successful. A single RemoteIssueLink will be returned when specifying `globalId`, otherwise an array of RemoteIssueLink is returned.

- union
  - RemoteIssueLink[]
    - `application` Application — The application the linked item is in.
      - `name` string — The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format "\[application name\] icon title". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". Grouping and sorting of links may place links without an application name last.
      - `type` string — The name-spaced type of the application, used by registered rendering apps.
    - `globalId` string — The global ID of the link, such as the ID of the item on the remote system.
    - `id` integer — The ID of the link.
    - `object` RemoteObject — The linked item.
      - `icon` Icon — An icon. If no icon is defined: * for a status icon, no status icon displays in Jira. * for the remote object icon, the default link icon displays in Jira.
        - `link` string — The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.
        - `title` string — The title of the icon. This is used as follows: * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira. * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "\[application name\] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link".
        - `url16x16` string — The URL of an icon that displays at 16x16 pixel in Jira.
      - `status` Status — The status of the item.
        - `icon` Icon — An icon. If no icon is defined: * for a status icon, no status icon displays in Jira. * for the remote object icon, the default link icon displays in Jira.
          - `link` string — The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.
          - `title` string — The title of the icon. This is used as follows: * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira. * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "\[application name\] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link".
          - `url16x16` string — The URL of an icon that displays at 16x16 pixel in Jira.
        - `resolved` boolean — Whether the item is resolved. If set to "true", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font.
      - `summary` string — The summary details of the item.
      - `title` string, required — The title of the item.
      - `url` string, required — The URL of the item.
    - `relationship` string — Description of the relationship between the issue and the linked item.
    - `self` string, uri — The URL of the link.
  - RemoteIssueLink — Details of an issue remote link.
    - `application` Application — The application the linked item is in.
      - `name` string — The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format "\[application name\] icon title". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". Grouping and sorting of links may place links without an application name last.
      - `type` string — The name-spaced type of the application, used by registered rendering apps.
    - `globalId` string — The global ID of the link, such as the ID of the item on the remote system.
    - `id` integer — The ID of the link.
    - `object` RemoteObject — The linked item.
      - `icon` Icon — An icon. If no icon is defined: * for a status icon, no status icon displays in Jira. * for the remote object icon, the default link icon displays in Jira.
        - `link` string — The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.
        - `title` string — The title of the icon. This is used as follows: * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira. * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "\[application name\] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link".
        - `url16x16` string — The URL of an icon that displays at 16x16 pixel in Jira.
      - `status` Status — The status of the item.
        - `icon` Icon — An icon. If no icon is defined: * for a status icon, no status icon displays in Jira. * for the remote object icon, the default link icon displays in Jira.
          - `link` string — The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.
          - `title` string — The title of the icon. This is used as follows: * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira. * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "\[application name\] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link".
          - `url16x16` string — The URL of an icon that displays at 16x16 pixel in Jira.
        - `resolved` boolean — Whether the item is resolved. If set to "true", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font.
      - `summary` string — The summary details of the item.
      - `title` string, required — The title of the item.
      - `url` string, required — The URL of the item.
    - `relationship` string — Description of the relationship between the issue and the linked item.
    - `self` string, uri — The URL of the link.

## Other responses

- `400` — Returned if the request is invalid.
- `401` — Returned if the authentication credentials are incorrect or missing.
- `403` — Returned if issue linking is disabled.
- `404` — Returned if the issue or remote issue link is not found or the user does not have permission to view the issue.
- `413` — Returned if the per-issue limit for remote links has been breached.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-2/versions/ec7f275dfee5/schema)
