Search Sheets

Searches all sheets that the user can access, for the specified text. If you have not 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!

External Documentation

To learn more, visit the Smartsheet documentation.

Basic Parameters

Parameter	Description
Modified Since	When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version.
Query	Text with which to perform the search. Enclose in double-quotes for an exact search.

Advanced Parameters

Parameter	Description
Include	When specified with a value of favoriteFlag, response indicates which returned items are favorites. favorite -- dashboards, folders, reports, sheets, templates, and workspaces will have the property favorite: true parentObjectFavorite -- attachments, discussions, summary fields, and rows will have the property parentObjectFavorite: true.
Location	When specified with a value of personalWorkspace, limits the response to only those items in the user's workspaces.
Scopes	If search fails, try using an array for each type of this comma-separated list of search filters.

Example Output

{
    "results": [
        {
            "contextData": [
                "string"
            ],
            "objectId": 0,
            "objectType": "Search result object type (attachment, dashboard, discussion, folder, report, row, sheet, summaryField, template, or workspace).",
            "parentObjectId": 0,
            "parentObjectName": "Search result parent object name.",
            "parentObjectType": "Search result parent object type (dashboard, folder, report, sheet, template, or workspace).",
            "proofUrl": "The proofUrl string will be present in the contextData if the discussion or attachment belongs to a proof.",
            "text": "Search result text excerpt."
        }
    ],
    "totalCount": 0
}

Workflow Library Example

Search Sheets with Smartsheet and Send Results Via Email

Preview this Workflow on desktop