# Search API schemas
> Current Froomle documentation ยท [View canonical page](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/schemas.html)
## Search API schemas
### Item
One content item returned by the Search API.
| Name | Description | Schema |
| --- | --- | --- |
| **information\_field**
_required_ | Optional metadata field configured per customer. | string |
| **item\_id**
_required_ | Identifier of the item in your catalog. | string |
| **type**
_required_ | Document type of the returned object. | string |
### SearchRequest
Specification of a search request body.
| Name | Description | Schema |
| --- | --- | --- |
| **autocorrect**
_optional_ | Whether the query should be autocorrected (default: `true`). | boolean |
| **filter\_by**
_optional_ | Filters that limit which items can appear. | [Filter](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/schemas.html#_search_filter) |
| **group\_by**
_optional_ | Fields used to split results into multiple lists (default: `[]`). | < string > array |
| **limit**
_optional_ | Number of items returned per list (default: `4`). | integer |
| **list\_size**
_optional_ | Number of items cached per list for later retrieval (default: `100`). | integer |
| **num\_lists**
_optional_ | Number of lists requested (default: `4`). | integer |
| **q**
_required_ | The search query typed by the user. | string |
| **page\_type**
_required_ | Page or surface for which the request is made. | string |
| **channel**
_optional_ | Channel identifier (e.g., web, iOS, Android). | string |
| **user\_id**
_optional_ | Logged-in user identifier. | string |
| **device\_id**
_required_ | Identifier for anonymous users or devices. | string |
| **histories**
_optional_ | Behavioral histories that improve personalization. | [Histories](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/schemas.html#_search_histories) |
### SearchResults
Response returned by the search endpoints.
| Name | Description | Schema |
| --- | --- | --- |
| **auto\_suggest**
_optional_ | Alternative query if autocorrect was triggered. | string |
| **lists**
_required_ | Grouped search results. | < [List](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/schemas.html#_search_list) > array |
| **num\_lists**
_required_ | Number of lists that were requested. | integer |
| **perfect\_match**
_optional_ | Exact match for the query, if available. | [Item](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/schemas.html#_search_item) |
| **request\_id**
_required_ | Identifier of the request to log alongside events. | string |
| **user\_group**
_optional_ | Experiment group the user belongs to. | string |
### CompletionRequest
Body accepted by the advanced completions endpoint.
| Name | Description | Schema |
| --- | --- | --- |
| **fuzziness**
_optional_ | Maximum edit distance when matching queries (default: `0`). | integer |
| **filter\_by**
_optional_ | Filters applied before generating completions. | [Filter](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/schemas.html#_search_filter) |
| **q**
_optional_ | Partial query string. | string |
| **user\_id**
_optional_ | User identifier. | string |
| **device\_id**
_optional_ | Device identifier. | string |
| **histories**
_optional_ | Interaction histories used to personalize results. | [Histories](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/schemas.html#_search_histories) |
### Completion
Payload returned by the completions endpoints.
| Name | Description | Schema |
| --- | --- | --- |
| **completions**
_required_ | List of suggested terms. | < [Item](https://docs.froomle.com/froomle-doc-main/v2/api_reference/search/schemas.html#_search_item) > array |
| **request\_id**
_required_ | Identifier of the completion request. | integer |
| **user\_group**
_optional_ | Experiment group the user belongs to. | string |