---
type: api
title: List links library items
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana/operation/operation-get-links
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana/operation/operation-get-links
products:
  - Kibana
---

# List links library items

Availability: Planned

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

## Paths

- `GET` `/api/links`
- `GET` `/s/{space_id}/api/links`

## Description

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Returns a paginated list of links library items. Each result includes title, description, and metadata. Use `GET /api/links/{id}` to retrieve the complete state.

## Authentication

- Api key: `Authorization: <value>`
  These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: `Authorization: ApiKey base64AccessApiKey`
- Basic: `Authorization: Basic <credentials>`

## Query string parameters

- `page` (number · min: 1 · default: 1) — optional
  The page of results to return.
- `per_page` (number · min: 1 · max: 1000 · default: 20) — optional
  The number of results to return per page.
- `query` (string) — optional
  Filters results by `title` and `description` using Elasticsearch [`simple_query_string`](https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query) syntax. Multi-word terms require all words to match.
- `tags` (string[] · max items: 100 · default: []) — optional
  A tag ID to include. Accepts a single tag ID or multiple tag IDs. When multiple are specified, library items matching any of the tag IDs are included.
- `excluded_tags` (string[] · max items: 100 · default: []) — optional
  A tag ID to exclude. Accepts a single tag ID or multiple tag IDs. When multiple are specified, library items matching any of the tag IDs are excluded.
- `tag_names` (string[] · max items: 100) — optional
  A tag name to include. Accepts a single tag name or multiple tag names. When multiple are specified, library items matching any of the tag names are included. If the same name is shared by multiple tags, items matching any of those tags are included.
- `excluded_tag_names` (string[] · max items: 100) — optional
  A tag name to exclude. Accepts a single tag name or multiple tag names. When multiple are specified, library items matching any of the tag names are excluded. If the same name is shared by multiple tags, items matching any of those tags are excluded.

## Responses

#### `200`

success

`application/json`

- `data` (object[] · min items: 0 · max items: 1000)
  List of links library items matching the query.
  - `data` (object)
    - `description` (string · max length: 10000)
      A short description of the links library item.
    - `title` (string · max length: 1000)
      The links library item title.
  - `id` (string · max length: 250)
  - `meta` (object)
    - `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.
- `meta` (object)
  - `page` (number · min: 1 · default: 1)
    The returned page of results.
  - `per_page` (number · min: 1 · max: 1000 · default: 20)
    The number of results returned per page.
  - `total` (number)
    The total number of results matching the query.
#### `403`

forbidden

## Code examples

#### Console

```console
GET kbn:/api/links?query=welcome&per_page=10
```

#### curl

```curl
curl -X GET "${KIBANA_URL}/api/links?query=welcome&per_page=10" \
  -H "Authorization: ApiKey ${API_KEY}"
```

## Response examples

#### Search links library items response

Returns a paginated list of links library items. Each result includes title, description, and metadata. Use `GET /api/links/{id}` to retrieve the complete state.

```json
{
  "data": [
    {
      "data": {
        "description": "A collection of important links",
        "title": "Important Resources"
      },
      "id": "0ee9d0ea-06a0-4a30-bf4e-be4d3ca85bf3",
      "meta": {
        "created_at": "2026-06-03T23:33:39.979Z",
        "created_by": "u_EWATCHX9oIEsmcXj8aA1FkcaY3DE-XEpsiGTjrR2PmM_0",
        "managed": false,
        "updated_at": "2026-06-03T23:33:39.979Z",
        "updated_by": "u_EWATCHX9oIEsmcXj8aA1FkcaY3DE-XEpsiGTjrR2PmM_0",
        "version": "WzEwNywxXQ=="
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 1
  }
}
```