List links library items | Kibana API documentation

List links library items Experimental; added in 9.6.0

GET /api/links

Spaces method and path for this operation:

get /s/{space_id}/api/links

Refer to 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.

Query parameters

page number

The page of results to return.

Minimum value is 1. Default value is 1.
per_page number

The number of results to return per page.

Minimum value is 1, maximum value is 1000. Default value is 20.
query string

Filters results by title and description using Elasticsearch simple_query_string syntax. Multi-word terms require all words to match.
tags array[string]

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.

Not more than 100 elements. Maximum length of each is 250. Default value is [] (empty).
excluded_tags array[string]

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.

Not more than 100 elements. Maximum length of each is 250. Default value is [] (empty).
tag_names array[string] Generally available; added in 9.6.0

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.

Not more than 100 elements.
excluded_tag_names array[string] Generally available; added in 9.6.0

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.

Not more than 100 elements.

Responses

200 application/json

success
Hide response attributes Show response attributes object
- data array[object] Required
  
  List of links library items matching the query.
  
  At least 0 but not more than 1000 elements.
  
  Hide data attributes Show data attributes object
  
  data object Required
  
  Additional properties are NOT allowed.
  
  Hide data attributes Show data attributes object
  
  description string
  
  A short description of the links library item.
  
  Maximum length is 10000.
  
  title string Required
  
  The links library item title.
  
  Maximum length is 1000.
  
  id string Required
  
  Maximum length is 250.
  
  meta object Required
  
  Additional properties are NOT allowed.
  
  Hide meta attributes Show meta attributes 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 Required
  
  Additional properties are NOT allowed.
  
  Hide meta attributes Show meta attributes object
  
  page number
  
  The returned page of results.
  
  Minimum value is 1. Default value is 1.
  
  per_page number
  
  The number of results returned per page.
  
  Minimum value is 1, maximum value is 1000. Default value is 20.
  
  total number Required
  
  The total number of results matching the query.
403

forbidden

GET /api/links

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

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

Response examples (200)

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.

{
  "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
  }
}