---
type: api
title: Search tags
description: Returns a paginated list of tags matching the optional `query` text.
url: https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-tags
resource: https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-tags
products:
  - Kibana
---

# Search tags

Authentication: required

Availability: Experimental since 9.5

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

## Paths

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

#### Path parameters

- `space_id` (string) — optional
  An identifier for the space. If `space_id` is not provided in the URL, the default space is used. Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

## Description

Returns a paginated list of tags matching the optional `query` text.

## Query string parameters

- `query` (string · max length: 2048) — optional
  Filters results by `name` and `description` using Elasticsearch [`simple_query_string`](https://www.elastic.co/docs/reference/query-languages/query-dsl/simple-query-string-query) syntax. Multi-word terms require all words to match.
- `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.

## Responses

#### `200`

success

`application/json`

- `data` (object[] · min items: 0 · max items: 1000)
  List of tags matching the query.
  - `data` (object)
    - `color` (string · min length: 1 · max length: 256)
      The tag color as a hex value (e.g. `#772299`). If omitted, a random color is generated.
    - `description` (string · max length: 2048)
      Optional description of the tag.
    - `name` (string · min length: 1 · max length: 256)
      The display name of the tag.
  - `id` (string)
    The tag ID.
  - `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/tags
```

#### curl

```curl
curl -X GET "${KIBANA_URL}/api/tags" \
  -H "Authorization: ApiKey ${API_KEY}"
```

## Response examples

#### Tags matching a search query

`application/json`

```json
{
  "data": [
    {
      "data": {
        "color": "#1BA9F5",
        "description": "Dashboards owned by engineering teams.",
        "name": "Engineering"
      },
      "id": "tag-engineering",
      "meta": {
        "created_at": "2026-06-01T12:00:00.000Z",
        "managed": false,
        "updated_at": "2026-06-01T12:00:00.000Z",
        "version": "WzEsMV0="
      }
    },
    {
      "data": {
        "color": "#54B399",
        "description": "Content used by operations teams.",
        "name": "Operations"
      },
      "id": "tag-operations",
      "meta": {
        "created_at": "2026-06-02T09:30:00.000Z",
        "managed": false,
        "updated_at": "2026-06-02T09:30:00.000Z",
        "version": "WzIsMV0="
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 2
  }
}
```