---
type: api
title: Get a links library item by ID
description: Returns the complete state of a links library item by ID.
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v0/operation/operation-get-links-id
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v0/operation/operation-get-links-id
products:
  - Kibana
---

# Get a links library item by ID

Availability: Planned

- Server: `https://{kibana_url}`

## Paths

- `GET` `/api/links/{id}`

- [Api key auth](/elastic/docs-builder/docs/4371/api/doc/kibana/v0/authentication#apikeyauth)
- [Basic auth](/elastic/docs-builder/docs/4371/api/doc/kibana/v0/authentication#basicauth)

#### Path Parameters

- `id` (string · max: 250)
  The unique ID of the links library item, as returned by the create or search endpoints.

## Description

Returns the complete state of a links library item by ID.

## Responses

#### `200`

success

`application/json`

- `data` (object)
  - `description` (string)
  - `layout` (enum)
    Whether to display the links in a horizontal or vertical layout.
    Values: `horizontal`, `vertical`
  - `links` ([] union oneOf · max: 100)
    The list of links to display.
    - **Kibana_HTTP_APIs_kbn-link-panel-type-dashboardLink**
      Link type. Set to dashboardLink for a link to another dashboard.
      - `destination` (string)
        Linked dashboard saved object ID.
      - `label` (string)
        The label of the link displayed in the UI.
      - `options` (object · default: {
  "open_in_new_tab": false,
  "use_filters": true,
  "use_time_range": true
})
        - `open_in_new_tab` (boolean · default: false)
          When enabled, the dashboard opens in a new browser tab.
        - `use_filters` (boolean · default: true)
          When enabled, filters are passed to the opening dashboard.
        - `use_time_range` (boolean · default: true)
          When enabled, time range is passed to the opening dashboard.
      - `type` (enum)
        Values: `dashboardLink`
    - **Kibana_HTTP_APIs_kbn-link-type-externalLink**
      Link type. Set to externalLink for a URL outside Kibana.
      - `destination` (string)
        The external URL to link to.
      - `label` (string)
        The label of the link displayed in the UI.
      - `options` (object · default: {
  "encode_url": true,
  "open_in_new_tab": true
})
        - `encode_url` (boolean · default: true)
          Whether to escape the URL with percent encoding
        - `open_in_new_tab` (boolean · default: true)
          Whether to open this link in a new tab when clicked.
      - `type` (enum)
        Values: `externalLink`
  - `tags` ([] string · max: 1000 · default: [])
    Tag IDs associated with this library item.
  - `title` (string)
- `id` (string · max: 250)
  The unique ID of the links library item, as returned by the create or search endpoints.
- `meta` ({})
  - `created_at` (string)
    Timestamp when the object was created (ISO 8601).
  - `created_by` (string)
    User profile ID of the user who created the object.
  - `managed` (boolean)
    When `true`, the object is managed by Kibana and cannot be edited by users.
  - `owner` (string)
    Identifier of the plugin or team that owns this object.
  - `updated_at` (string)
    Timestamp when the object was last updated (ISO 8601).
  - `updated_by` (string)
    User profile ID of the user who last updated the object.
  - `version` (string)
    Internal version identifier for optimistic concurrency control.
#### `403`

forbidden

#### `404`

A links library item with the given ID was not found.

## Code Examples

#### Console

```console
GET kbn:/api/links/0ee9d0ea-06a0-4a30-bf4e-be4d3ca85bf3
```

#### curl

```curl
curl -X GET "${KIBANA_URL}/api/links/0ee9d0ea-06a0-4a30-bf4e-be4d3ca85bf3" \
  -H "Authorization: ApiKey ${API_KEY}"
```

## Response Examples

#### Get links library item response

The full links library item state including `links`, `layout`, `title`, `description`, and metadata.

```json
{
  "data": {
    "description": "A collection of important links",
    "layout": "horizontal",
    "links": [
      {
        "destination": "dashboard-abc-123",
        "label": "Overview",
        "options": {
          "open_in_new_tab": false,
          "use_filters": true,
          "use_time_range": true
        },
        "type": "dashboardLink"
      },
      {
        "destination": "https://www.elastic.co/docs",
        "label": "Elastic Documentation",
        "options": {
          "encode_url": true,
          "open_in_new_tab": true
        },
        "type": "externalLink"
      }
    ],
    "title": "Important Resources"
  },
  "id": "0ee9d0ea-06a0-4a30-bf4e-be4d3ca85bf3",
  "meta": {
    "created_at": "2026-04-13T10:00:00.000Z",
    "managed": false,
    "updated_at": "2026-04-13T10:00:00.000Z",
    "version": "WzU5LDFd"
  }
}
```