FIfieldwire
sheets

Get highlighted search results on a sheet

Retrieve a list of highlighted regions for 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

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

idstring uuid required

ID of the entity

Query parameters

qstring required

The search query.

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Response

Successful response

textstring required

The highlighted text.

Changes

No recorded changes to this operation across all 1 revision of this API.