---
title: "Get a Remote Link by ID"
method: GET
path: "/rest/remotelinks/1.0/remotelink/{remoteLinkId}"
tags: ["Remote Links"]
---

# Get a Remote Link by ID

`GET /rest/remotelinks/1.0/remotelink/{remoteLinkId}`

Retrieve the currently stored Remote Link data for the given ID.

The result will be what is currently stored, ignoring any pending updates or deletes.

## Path parameters

- `remoteLinkId` string, required

## Response `200`

The Remote Link data currently stored for the given ID.

- object — Data related to a single Remote Link.
  - `schemaVersion` '1.0' — The schema version used for this data. Placeholder to support potential schema changes in the future.
  - `id` string, required — The identifier for the Remote Link. Must be unique for a given Provider.
  - `updateSequenceNumber` integer, required — An ID used to apply an ordering to updates for this Remote Link in the case of out-of-order receipt of update requests. It must be a monotonically increasing number. For example, epoch time could be one way to generate the `updateSequenceNumber`. Updates for a Remote Link that is received with an `updateSqeuenceNumber` less than or equal to what is currently stored will be ignored.
  - `displayName` string, required — The human-readable name for the Remote Link. Will be shown in the UI.
  - `url` string, uri, required — The URL to this Remote Link in your system.
  - `type` 'document' | 'alert' | 'test' | 'security' | 'logFile' | 'prototype' | 'coverage' | 'bugReport' | 'other', required — The type of the Remote Link. The current supported types are 'document', 'alert', 'test', 'security', 'logFile', 'prototype', 'coverage', 'bugReport' and 'other'
  - `description` string — An optional description to attach to this Remote Link. This may be anything that makes sense in your system.
  - `lastUpdated` string, date-time, required — The last-updated timestamp to present to the user as a summary of when Remote Link was last updated.
  - `associations` union[] — The entities to associate the Remote Link information with.
    - union
      - IssueIdOrKeysAssociation — An association type referencing issues in Jira.
        - `associationType` 'issueKeys' | 'issueIdOrKeys', required — Defines the association type.
        - `values` string[], required — The Jira issue keys or IDs to associate the entity with. The number of values counted across all associationTypes must not exceed a limit of 500.
      - ServiceIdOrKeysAssociation — An association type referencing service ID or keys.
        - `associationType` 'serviceIdOrKeys', required — Defines the association type.
        - `values` string[], required — The service ID or keys to associate the entity with. The number of values counted across all associationTypes must not exceed a limit of 500.
  - `status` object — The status of a Remote Link.
    - `appearance` 'default' | 'inprogress' | 'moved' | 'new' | 'removed' | 'prototype' | 'success', required — Appearance is a fixed set of appearance types affecting the colour of the status lozenge in the UI. The colours they correspond to are equivalent to atlaskit's [Lozenge](https://atlaskit.atlassian.com/packages/core/lozenge) component.
    - `label` string, required — The human-readable description for the Remote Link status. Will be shown in the UI.
  - `actionIds` string[] — Optional list of actionIds. They are associated with the actions the provider is able to provide when they registered. Indicates which actions this Remote Link has. If any actions have a templateUrl that requires string substitution, then `attributeMap` must be passed in.
  - `attributeMap` object — Map of key/values (string to string mapping). This is used to build the urls for actions from the templateUrl the provider registered their available actions with.

## Other responses

- `401` — Missing a JWT token, or token is invalid.
- `403` — The JWT token used does not correspond to an app that defines the `jiraRemoteLinkInfoProvider` module, or the app does not define the 'READ' scope.
- `404` — No Remote Link data found for the given ID.
- `429` — API rate limit has been exceeded.
- `503` — Service is unavailable due to maintenance or other reasons.
- `default` — An unknown error has occurred.

---

[API](https://skmtc.net/atlassian/apis/jira-software-cloud-api.md) · [All operations](https://skmtc.net/atlassian/apis/jira-software-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/jira-software-cloud-api/revisions/4e108d54b990/schema)