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

ParameterDescription
Modified SinceWhen 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.
QueryText with which to perform the search. Enclose in double-quotes for an exact search.

​
Advanced Parameters

ParameterDescription
IncludeWhen 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.
LocationWhen specified with a value of personalWorkspace, limits the response to only those items in the user’s workspaces.
ScopesIf search fails, try using an array for each type of this comma-separated list of search filters.

​
Example Output

{
	"results": [
		{
			"text": "<string>",
			"objectType": "<string>",
			"objectId": 2839089213461133,
			"contextData": [
				"<string>"
			]
		}
	],
	"totalCount": 1
}

​
Workflow Library Example

Search Sheets with Smartsheet and Send Results Via Email

Preview this Workflow on desktop

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

ParameterDescription
Modified SinceWhen 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.
QueryText with which to perform the search. Enclose in double-quotes for an exact search.

​
Advanced Parameters

ParameterDescription
IncludeWhen 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.
LocationWhen specified with a value of personalWorkspace, limits the response to only those items in the user’s workspaces.
ScopesIf search fails, try using an array for each type of this comma-separated list of search filters.

​
Example Output

{
	"results": [
		{
			"text": "<string>",
			"objectType": "<string>",
			"objectId": 2839089213461133,
			"contextData": [
				"<string>"
			]
		}
	],
	"totalCount": 1
}

​
Workflow Library Example

Search Sheets with Smartsheet and Send Results Via Email

Preview this Workflow on desktop