# GET /{environment}/searches/lists

> Current Froomle documentation · [View canonical page](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/operations/lists_with_env.html)

<a id="_description"></a>

## Description

Query cached search results from a previously computed list.

<a id="_parameters"></a>

## Parameters

| Type | Name | Description | Schema |
| --- | --- | --- | --- |
| **Path** | **environment**<br>_required_ | The environment for which the list request is made. | string |
| **Query** | **list\_key**<br>_required_ | Identifier of the cached list returned by an earlier search. | string |
| **Query** | **offset**<br>_required_ | Rank of the first item to include (1-based). | integer |
| **Query** | **limit**<br>_required_ | Number of items to return. | integer |

<a id="_responses"></a>

## Responses

| HTTP Code | Description | Schema |
| --- | --- | --- |
| **200** | OK | [SearchResults](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/operations/lists_with_env.html#_searchresults) |
| **404** | List key not found or expired. | No Content |

<a id="_produces"></a>

## Produces

-   `application/json`
    

* * *

<a id="_search_item"></a>

### Item

One content item returned by the Search API.

| Name | Description | Schema |
| --- | --- | --- |
| **information\_field**<br>_required_ | Optional metadata field configured per customer. | string |
| **item\_id**<br>_required_ | Identifier of the item in your catalog. | string |
| **type**<br>_required_ | Document type of the returned object. | string |

<a id="_search_list"></a>

### List

Represents a grouped subset of search results.

| Name | Description | Schema |
| --- | --- | --- |
| **grouped\_by**<br>_optional_ | Values of the `group_by` keys shared by every item in the list. | < string > array |
| **items**<br>_optional_ | Items contained in this list. | < [Item](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/operations/lists_with_env.html#_search_item) > array |
| **limit**<br>_optional_ | Number of items returned in this list. | integer |
| **list\_key**<br>_optional_ | Identifier that lets you re-fetch remaining items. | string |
| **list\_name**<br>_optional_ | Server-generated name of the list. | string |
| **list\_size**<br>_optional_ | Total number of cached items for this list. | integer |

<a id="_searchresults"></a>

### SearchResults

Response returned by the search endpoints.

| Name | Description | Schema |
| --- | --- | --- |
| **auto\_suggest**<br>_optional_ | Alternative query if autocorrect was triggered. | string |
| **lists**<br>_required_ | Grouped search results. | < [List](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/operations/lists_with_env.html#_search_list) > array |
| **num\_lists**<br>_required_ | Number of lists that were requested. | integer |
| **perfect\_match**<br>_optional_ | Exact match for the query, if available. | [Item](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/operations/lists_with_env.html#_search_item) |
| **request\_id**<br>_required_ | Identifier of the request to log alongside events. | string |
| **user\_group**<br>_optional_ | Experiment group the user belongs to. | string |