---
title: "Get typeahead suggestions"
method: GET
path: "/typeahead/suggestions"
---

# Get typeahead suggestions

`GET /typeahead/suggestions`

The `GET /typeahead/suggestions` request retrieves a list of typeahead suggestions.

A total of 5,000 suggestions are allowed in the following distribution:

1. Your organization can enter a maximum of 4,000 custom terms (included and excluded) in the Core Settings Typeahead user interface.

2. Every hour, a maximum of 1,000 of the terms entered most often in customer searches are added to the Included typeahead suggestions list.

Results are sorted alphabetically. Sort options are not currently available.

The optional `prefix` query parameter filters suggestions returned. For example, `GET /typeahead/suggestions?prefix=El` returns the suggestions that begin with the letters `El`.

The optional `limit` query parameter limits the maximum number of suggestions returned. For example, `GET /typeahead/suggestions?limit=10` returns a maximum of 10 suggestions.

## Query parameters

- `prefix` string
- `limit` integer

## Headers

- `Authorization` string, required
- `Content-Type` string, required

## Response `200`

Suggestions retrieved successfully

- string[]

---

[API](https://skmtc.net/lucidworks/apis/rules-rewrites-api.md) · [All operations](https://skmtc.net/lucidworks/apis/rules-rewrites-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lucidworks/rules-rewrites-api/versions/f2d3747848e8/schema)