# Get terms in an index


**POST /{index}/_terms_enum**

**All methods and paths for this operation:**

<div>
                      <span class="operation-verb get">GET</span>
                      <span class="operation-path">/{index}/_terms_enum</span>
                      </div>
                    <div>
                      <span class="operation-verb post">POST</span>
                      <span class="operation-path">/{index}/_terms_enum</span>
                      </div>
                    

Discover terms that match a partial string in an index.
This API is designed for low-latency look-ups used in auto-complete scenarios.

> info
> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.


## Servers
- http://api.example.com: http://api.example.com ()


## Authentication methods
- Api key auth


## Parameters

### Path parameters
- **index** (string)
  A comma-separated list of data streams, indices, and index aliases to search.
  Wildcard (`*`) expressions are supported.
  To search all data streams or indices, omit this parameter or use `*`  or `_all`.


### Body: application/json (object)

- **field** (string)
  The string to match at the start of indexed terms. If not provided, all terms in the field are considered.
- **size** (number)
  The number of matching terms to return.
- **timeout** (string)
  The maximum length of time to spend collecting results.
  If the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.
- **case_insensitive** (boolean)
  When `true`, the provided search string is matched against index terms without case sensitivity.
- **index_filter** (object)
  Filter an index shard if the provided query rewrites to `match_none`.
- **string** (string)
  The string to match at the start of indexed terms.
  If it is not provided, all terms in the field are considered.

  > info
  > The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.
- **search_after** (string)
  The string after which terms in the index should be returned.
  It allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request.


## Responses
### 200


#### Body: application/json (object)
- **_shards** (object)

- **terms** (array[string])

- **complete** (boolean)
  If `false`, the returned terms set may be incomplete and should be treated as approximate.
  This can occur due to a few reasons, such as a request timeout or a node error.


[Powered by Bump.sh](https://bump.sh)