---
title: "Search sheet"
method: GET
path: "/search/sheets/{sheetId}"
tags: ["search"]
---

# Search sheet

`GET /search/sheets/{sheetId}`

Gets a list of the user's search results in a sheet, based on a query.

The list contains an abbreviated row object for each query-matching row in the sheet. 

> **Important:** If you have't used the public API in a while, we will need to provision your
data. This could take up to 24 hours so please check back later!

> **Note:** Newly created or recently updated data may not be immediately discoverable
via search.

## Query parameters

- `query` string, required

## Response `200`

Object that contains an array of matching items in the sheet and the total count of those items.

- SearchResult
  - `results` union[] — Array of matching items.
    - union
      - SearchResultItem — Represents an item that matches the search query.
        - `text` string — Excerpt of the item's matching text.
        - `objectType` 'attachment' | 'sight' | 'discussion' | 'folder' | 'report' | 'row' | 'sheet' | 'summaryField' | 'template' | 'workspace' — The matching item's type.
        - `objectId` number — The matching item's ID.
        - `contextData` string[] — Additional information about the matching item. If the item has a discussion or attachment belonging to a proof, the context data includes the URL of that proof (for example, `"proofUrl: https://app.smartsheet.com/b/proofs/sheets/abc123/proofs/def456"`).
        - `favorite` boolean — `true` if the item is one of the user's favorites.
      - SearchResultSubItem — Represents an item that matches the search query and is a sub-component of another item. For example, a row is a sub-component of a sheet. Both are items that can match a search query.
        - `text` string — Excerpt of the item's matching text.
        - `objectType` 'attachment' | 'sight' | 'discussion' | 'folder' | 'report' | 'row' | 'sheet' | 'summaryField' | 'template' | 'workspace' — The matching item's type.
        - `objectId` number — The matching item's ID.
        - `contextData` string[] — Additional information about the matching item. If the item has a discussion or attachment belonging to a proof, the context data includes the URL of that proof (for example, `"proofUrl: https://app.smartsheet.com/b/proofs/sheets/abc123/proofs/def456"`).
        - `parentObjectType` 'dashboard' | 'folder' | 'report' | 'sheet' | 'template' | 'workspace' — The type of the item's parent.
        - `parentObjectId` number — The ID of the item's parent.
        - `parentObjectName` string — The name of the item's parent.
        - `parentObjectFavorite` boolean — `true` if the parent is one of the user's favorites.
  - `totalCount` number — Total number of search results in the `results` array.

## Other responses

- `default` — Generic Error Payload

---

[API](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference.md) · [All operations](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartsheet/smartsheet-openapi-reference/revisions/b4afda95fb51/schema)