GET /search
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!
Servers
- https://api.smartsheet.com/2.0
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
scopes[] |
Array | No |
If search fails, try using an array for each type of this comma-separated list of search filters. |
query |
String | Yes |
Text with which to perform the search. Enclose in double-quotes for an exact search. |
include |
String | No |
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 |
String | No |
When specified with a value of personalWorkspace, limits the response to only those items in the user's workspaces. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.