---
title: "Get highlighted search results on a sheet"
method: GET
path: "/api/v3/projects/{project_id}/sheets/{id}/sheet_highlights"
tags: ["sheets"]
---

# Get highlighted search results on a sheet

`GET /api/v3/projects/{project_id}/sheets/{id}/sheet_highlights`

## Request

- Base URL: `https://client-api.us.fieldwire.com`
- URL: `https://client-api.us.fieldwire.com/api/v3/projects/{project_id}/sheets/{id}/sheet_highlights`
- Auth: HTTP bearer

Retrieve a list of highlighted regions for search results on a sheet

## Path parameters

- `project_id` string, uuid, required
- `id` string, uuid, required

## Query parameters

- `q` string, required: The search query.

## Headers

- `Fieldwire-Version` string, date, required

## Response `200`

Successful response

- object[]: Highlighted Sheet search results.
  - `text` string, required: The highlighted text.
  - `highlights` object[], required: Highlighted regions on the sheet.
    - `xmin` number, required: The minimum x-coordinate of the bounding box.
    - `xmax` number, required: The maximum x-coordinate of the bounding box.
    - `ymin` number, required: The minimum y-coordinate of the bounding box.
    - `ymax` number, required: The maximum y-coordinate of the bounding box.

## Other responses

- `422`: Error if account does not support plan text search

---

[API](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api.md) - [All operations](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api/revisions/34b820438c0b?raw)