---
title: "Return search results"
method: GET
path: "/search"
tags: ["Search"]
---

# Return search results

`GET /search`

The `results` map preserves the order of the `sort` parameter (Lucene scoring order for `relevancy`).

## Query parameters

- `full` string
- `def` string
- `symbol` string
- `path` string
- `hist` string
- `type` string
- `projects` string
- `maxresults` integer
- `start` integer
- `maxhitsperfile` integer
- `sort` 'relevancy' | 'fullpath' | 'lastmodtime'

## Response `200`

Search results.

- SearchResponse
  - `time` integer
  - `resultCount` integer
  - `startDocument` integer
  - `endDocument` integer
  - `results` object

---

[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)