# Retrieve Link

To retrieve a link of the account associated with the IAM Federation in the form of an `ID`, perform a `GET` request.

## Endpoint

Use the following endpoint to retrieve a link: `https://iam.ionos.com/federation/links/{linkId}`.

## Request

{% hint style="info" %}
**Note:** The following request contains a sample `linkId`. Replace them with the `linkId` value, whose information you want to retrieve.
{% endhint %}

```bash
curl --location \
--request GET 'https://iam.ionos.com/federation/links/5eb3d304-dc75-56cb-9b94-152533912d33' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiO' \
--header 'Content-Type: application/json'
```

{% tabs %}
{% tab title="Path Parameters" %}
Below is the list of mandatory path parameter:

| **Body Parameters** | **Type** | **Description**            | **Example**                            |
| ------------------- | -------- | -------------------------- | -------------------------------------- |
| `linkId`            | string   | The ID (UUID) of the link. | `5eb3d304-dc75-56cb-9b94-152533912d33` |
| {% endtab %}        |          |                            |                                        |

{% tab title="Request Header Parameters" %}
To make authenticated requests to the API, the following fields are mandatory in the request header:

| **Header Parameters** | **Required** | **Type** | **Description**                                                                                                                                                                                                                                                                        |
| --------------------- | :----------: | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Authorization`       |      yes     |  string  | The Bearer token enables requests to authenticate using a JSON Web Token (JWT). From the DCD, [<mark style="color:blue;">Generate authentication token</mark>](https://docs.ionos.com/sections-test/guides/set-up-ionos-cloud/management/token-manager#generate-authentication-token). |
| `Content-Type`        |      yes     |  string  | Set this to `application/json`.                                                                                                                                                                                                                                                        |
| {% endtab %}          |              |          |                                                                                                                                                                                                                                                                                        |
| {% endtabs %}         |              |          |                                                                                                                                                                                                                                                                                        |

## Response

**200 Successful operation**

```bash
{
  "id": "5eb3d304-dc75-56cb-9b94-152533912d33",
  "type": "link",
  "href": "/links/5eb3d304-dc75-56cb-9b94-152533912d33",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>"
  },
  "properties": {
    "id": "ac6f04c2-68e1-5e61-97c8-ef0216f1c08e",
    "providerAlias": "oidc",
    "displayName": "IdentityProvider ABC",
    "linkedUsername": "linkedUsername ABC",
    "linked": true
  }
}
```