---
title: "Responses Search"
method: GET
path: "/api/responses/"
tags: ["Responses"]
---

# Responses Search

`GET /api/responses/`

Searches for `q` in the selected `indices` and returns up to 20 search results, starting from the `start+1` document.
  
❗️ This method allows retrieving only the first 10,000 search results.

Use it when the expected number of results is relatively low or to craft and refine a query.
Use the __Download__ endpoint to fetch results without pagination or quantity limitations.

## Query parameters

- `q` string, required — The query string used for searching. See [Query Syntax](/knowledge-base/query-language/) for more details.
- `start` integer — Use for pagination. Offset from the first search result to return.
- `indices` IndiceLabel[] — A list of indice labels to search in. If not provided, the search will be performed in the default (most relevant index). Call [indices](#tag/Indices) endpoint to get the list of available indices.
- `fields` Field[] — You can control the amount of output data by specifying which fields to include or exclude in the response. Use the `source_type` parameter to select between `include` and `exclude` options.
- `source_type` 'include' | 'exclude' — Specify `fields` and use `source_type` to choose between: - `include` to return only the specified fields - `exclude` to return all fields except the specified ones

## Response `200`

__Search Results__

- ResponsesSearch
  - `items` object[], required — 0 to 20 documents that match the search query
    - `highlight` Highlight — A pattern matched in the document, used for highlighting data in the search results
    - `data` ResponseDocument — An object representing the response

## Other responses

- `400` — __Bad Request__: Some required parameters were not passed or were not validated
- `402` — __Not Enough Coins__: You are out of your current subscription plan limits
- `403` — __Access Denied__: You are not allowed to perform this action Error details are included in the response body.
- `429` — __Daily request limit exceeded__ or __Request throttled__. Additional error details are provided in the response body
- `500` — __Internal Server Error__: Details are included in the response body
- `504` — __Timeout__: The request took too long to process

---

[API](https://skmtc.net/netlas/apis/netlas-api.md) · [All operations](https://skmtc.net/netlas/apis/netlas-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netlas/netlas-api/revisions/2b1f84425791/schema)