---
title: "Return suggestions"
method: GET
path: "/suggest"
tags: ["Suggester"]
---

# Return suggestions

`GET /suggest`

## Query parameters

- `projects` string, required
- `field` string, required
- `caret` integer, required
- `full` string
- `defs` string
- `refs` string
- `path` string
- `hist` string
- `type` string

## Response `200`

Suggestions.

- SuggestResponse
  - `time` integer
  - `suggestions` Suggestion[]
    - `phrase` string
    - `projects` string[]
    - `score` number
  - `identifier` string
  - `queryText` string
  - `partialResult` boolean

---

[API](https://skmtc.net/oracle/apis/opengrok-restful-api.md) · [All operations](https://skmtc.net/oracle/apis/opengrok-restful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oracle/opengrok-restful-api/revisions/4844bf710203/schema)
