Search sheet

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.

get/search/sheets/{sheetId}

Request

Base URL
https://api.smartsheet.com/2.0
Auth
- HTTP bearer
- or OAuth 2
  Authorization code: https://app.smartsheet.com/b/authorize
  Token URL: https://api.smartsheet.com/2.0/token scopes: READ_SHEETS

Query parameters

querystring required

Text with which to perform the search.

Tip: To match the exact text, wrap the query in double-quotes.

Response

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

totalCountnumber

Total number of search results in the results array.

Example response

{
  "results": [
    {
      "objectType": "row",
      "objectId": 12345678,
      "favorite": true
    }
  ],
  "totalCount": 1
}

Changes

No recorded changes to this operation across all 16 revisions of this API.