--- title: "Get issue link" method: GET path: "/rest/api/3/issueLink/{linkId}" tags: ["Issue links"] --- # Get issue link `GET /rest/api/3/issueLink/{linkId}` Returns an issue link. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse project* [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the linked issues. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, permission to view both of the issues. ## Path parameters - `linkId` string, required ## Response `200` Returned if the request is successful. - IssueLink — Details of a link between issues. - `id` string — The ID of the issue link. - `inwardIssue` LinkedIssue, required — The ID or key of a linked issue. - `fields` Fields — Key fields from the linked issue. - `assignee` UserDetails — User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. - `accountType` string — The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) - `active` boolean — Whether the user is active. - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `displayName` string — The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy settings, this may be returned as null. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. - `issueType` IssueTypeDetails — Details about an issue type. - `avatarId` integer — The ID of the issue type's avatar. - `description` string — The description of the issue type. - `entityId` string, uuid — Unique ID for next-gen projects. - `hierarchyLevel` integer — Hierarchy level of the issue type. - `iconUrl` string — The URL of the issue type's avatar. - `id` string — The ID of the issue type. - `name` string — The name of the issue type. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - `avatarUrls` AvatarUrlsBean - … - `id` string — The ID of the project. - `key` string — The key of the project. - `name` string — The name of the project. - `projectCategory` UpdatedProjectCategory — A project category. - … - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. - `self` string — The URL of the project details. - `simplified` boolean — Whether or not the project is simplified. - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `self` string — The URL of these issue type details. - `subtask` boolean — Whether this issue type is used to create subtasks. - `issuetype` IssueTypeDetails — Details about an issue type. - `avatarId` integer — The ID of the issue type's avatar. - `description` string — The description of the issue type. - `entityId` string, uuid — Unique ID for next-gen projects. - `hierarchyLevel` integer — Hierarchy level of the issue type. - `iconUrl` string — The URL of the issue type's avatar. - `id` string — The ID of the issue type. - `name` string — The name of the issue type. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - `avatarUrls` AvatarUrlsBean - … - `id` string — The ID of the project. - `key` string — The key of the project. - `name` string — The name of the project. - `projectCategory` UpdatedProjectCategory — A project category. - … - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. - `self` string — The URL of the project details. - `simplified` boolean — Whether or not the project is simplified. - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `self` string — The URL of these issue type details. - `subtask` boolean — Whether this issue type is used to create subtasks. - `priority` Priority — An issue priority. - `avatarId` integer — The avatarId of the avatar for the issue priority. This parameter is nullable and when set, this avatar references the universal avatar APIs. - `description` string — The description of the issue priority. - `iconUrl` string — The URL of the icon for the issue priority. - `id` string — The ID of the issue priority. - `isDefault` boolean — Whether this priority is the default. - `name` string — The name of the issue priority. - `schemes` ExpandPrioritySchemePage - `maxResults` integer - `startAt` integer - `total` integer - `self` string — The URL of the issue priority. - `statusColor` string — The color used to indicate the issue priority. - `status` StatusDetails — A status. - `description` string — The description of the status. - `iconUrl` string — The URL of the icon used to represent the status. - `id` string — The ID of the status. - `name` string — The name of the status. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - `avatarUrls` AvatarUrlsBean - … - `id` string — The ID of the project. - `key` string — The key of the project. - `name` string — The name of the project. - `projectCategory` UpdatedProjectCategory — A project category. - … - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. - `self` string — The URL of the project details. - `simplified` boolean — Whether or not the project is simplified. - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `self` string — The URL of the status. - `statusCategory` StatusCategory — A status category. - `colorName` string — The name of the color used to represent the status category. - `id` integer — The ID of the status category. - `key` string — The key of the status category. - `name` string — The name of the status category. - `self` string — The URL of the status category. - `summary` string — The summary description of the linked issue. - `timetracking` TimeTrackingDetails — Time tracking details. - `originalEstimate` string — The original estimate of time needed for this issue in readable format. - `originalEstimateSeconds` integer — The original estimate of time needed for this issue in seconds. - `remainingEstimate` string — The remaining estimate of time needed for this issue in readable format. - `remainingEstimateSeconds` integer — The remaining estimate of time needed for this issue in seconds. - `timeSpent` string — Time worked on this issue in readable format. - `timeSpentSeconds` integer — Time worked on this issue in seconds. - `id` string — The ID of an issue. Required if `key` isn't provided. - `key` string — The key of an issue. Required if `id` isn't provided. - `self` string, uri — The URL of the issue. - `outwardIssue` LinkedIssue, required — The ID or key of a linked issue. - `fields` Fields — Key fields from the linked issue. - `assignee` UserDetails — User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. - `accountType` string — The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) - `active` boolean — Whether the user is active. - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `displayName` string — The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy settings, this may be returned as null. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. - `issueType` IssueTypeDetails — Details about an issue type. - `avatarId` integer — The ID of the issue type's avatar. - `description` string — The description of the issue type. - `entityId` string, uuid — Unique ID for next-gen projects. - `hierarchyLevel` integer — Hierarchy level of the issue type. - `iconUrl` string — The URL of the issue type's avatar. - `id` string — The ID of the issue type. - `name` string — The name of the issue type. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - `avatarUrls` AvatarUrlsBean - … - `id` string — The ID of the project. - `key` string — The key of the project. - `name` string — The name of the project. - `projectCategory` UpdatedProjectCategory — A project category. - … - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. - `self` string — The URL of the project details. - `simplified` boolean — Whether or not the project is simplified. - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `self` string — The URL of these issue type details. - `subtask` boolean — Whether this issue type is used to create subtasks. - `issuetype` IssueTypeDetails — Details about an issue type. - `avatarId` integer — The ID of the issue type's avatar. - `description` string — The description of the issue type. - `entityId` string, uuid — Unique ID for next-gen projects. - `hierarchyLevel` integer — Hierarchy level of the issue type. - `iconUrl` string — The URL of the issue type's avatar. - `id` string — The ID of the issue type. - `name` string — The name of the issue type. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - `avatarUrls` AvatarUrlsBean - … - `id` string — The ID of the project. - `key` string — The key of the project. - `name` string — The name of the project. - `projectCategory` UpdatedProjectCategory — A project category. - … - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. - `self` string — The URL of the project details. - `simplified` boolean — Whether or not the project is simplified. - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `self` string — The URL of these issue type details. - `subtask` boolean — Whether this issue type is used to create subtasks. - `priority` Priority — An issue priority. - `avatarId` integer — The avatarId of the avatar for the issue priority. This parameter is nullable and when set, this avatar references the universal avatar APIs. - `description` string — The description of the issue priority. - `iconUrl` string — The URL of the icon for the issue priority. - `id` string — The ID of the issue priority. - `isDefault` boolean — Whether this priority is the default. - `name` string — The name of the issue priority. - `schemes` ExpandPrioritySchemePage - `maxResults` integer - `startAt` integer - `total` integer - `self` string — The URL of the issue priority. - `statusColor` string — The color used to indicate the issue priority. - `status` StatusDetails — A status. - `description` string — The description of the status. - `iconUrl` string — The URL of the icon used to represent the status. - `id` string — The ID of the status. - `name` string — The name of the status. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - `avatarUrls` AvatarUrlsBean - … - `id` string — The ID of the project. - `key` string — The key of the project. - `name` string — The name of the project. - `projectCategory` UpdatedProjectCategory — A project category. - … - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. - `self` string — The URL of the project details. - `simplified` boolean — Whether or not the project is simplified. - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `self` string — The URL of the status. - `statusCategory` StatusCategory — A status category. - `colorName` string — The name of the color used to represent the status category. - `id` integer — The ID of the status category. - `key` string — The key of the status category. - `name` string — The name of the status category. - `self` string — The URL of the status category. - `summary` string — The summary description of the linked issue. - `timetracking` TimeTrackingDetails — Time tracking details. - `originalEstimate` string — The original estimate of time needed for this issue in readable format. - `originalEstimateSeconds` integer — The original estimate of time needed for this issue in seconds. - `remainingEstimate` string — The remaining estimate of time needed for this issue in readable format. - `remainingEstimateSeconds` integer — The remaining estimate of time needed for this issue in seconds. - `timeSpent` string — Time worked on this issue in readable format. - `timeSpentSeconds` integer — Time worked on this issue in seconds. - `id` string — The ID of an issue. Required if `key` isn't provided. - `key` string — The key of an issue. Required if `id` isn't provided. - `self` string, uri — The URL of the issue. - `self` string, uri — The URL of the issue link. - `type` IssueLinkType, required — This object is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it defines and reports on the type of link between the issues. Find a list of issue link types with [Get issue link types](#api-rest-api-3-issueLinkType-get). * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it defines and reports on issue link types. - `id` string — The ID of the issue link type and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is read only. - `inward` string — The description of the issue link type inward link and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only. - `name` string — The name of the issue link type and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only. - `outward` string — The description of the issue link type outward link and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only. - `self` string, uri — The URL of the issue link type. Read only. ## Other responses - `400` — Returned if the issue link ID is invalid. - `401` — Returned if the authentication credentials are incorrect or missing. - `404` — Returned if: * issue linking is disabled. * the issue link is not found. * the user doesn't have the required permissions. --- [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/5a51740d7ab3/schema)