Skip to main content
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 DocumentationTo 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

{
	"results": [
		{
			"text": "<string>",
			"objectType": "<string>",
			"objectId": 5629216466330474,
			"parentObjectType": "<string>",
			"parentObjectId": 2307360792305022,
			"parentObjectName": "<string>",
			"contextData": [
				"<string>"
			]
		},
		{
			"text": "<string>",
			"objectType": "<string>",
			"objectId": 3241681216492671,
			"parentObjectType": "<string>",
			"parentObjectId": 871346918154382,
			"parentObjectName": "<string>",
			"contextData": [
				"<string>"
			]
		}
	],
	"totalCount": 2
}

​
Workflow Library Example

List Search Sheet with Smartsheet and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop
⌘I