Search tags Experimental; added in 9.5.0

GET /api/tags
Api key auth Basic auth

Spaces method and path for this operation:

get /s/{space_id}/api/tags

Refer to Spaces for more information.

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

Query parameters

  • query string

    Filters results by name and description using Elasticsearch simple_query_string syntax. Multi-word terms require all words to match.

  • 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.

Responses

  • 200 application/json

    success

    Hide response attributes Show response attributes object
    • data array[object] Required

      List of tags 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
        • color string Required

          The tag color as a hex value (e.g. #772299). If omitted, a random color is generated.

        • description string

          Optional description of the tag.

        • name string Required

          The display name of the tag.

      • id string Required

        The tag ID.

      • 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/tags 
curl \
 --request GET 'https://localhost:5601/api/tags' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "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
  }
}