​
List Search Sheet

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

The list contains an abbreviated row object for each search result in a sheet.

Note: If you haven’t used the Smartsheet API recently, data provisioning may take up to 24 hours.

External Documentation

To learn more, visit the Smartsheet documentation.

​
Parameters

ParameterDescription
QueryThe query with which to perform the search.
Sheet IDSheet ID of the sheet being accessed.

​
Example Output

{
	"result": [
		{
			"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."
		}
	],
	"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

List Search Sheet with Smartsheet and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?

List ColumnsList Sheets