Search Everything
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!
query Parameters
| query required | string Text with which to perform the search. Enclose in double-quotes for an exact search. |
| location | string Deprecated Default: "" Deprecated When specified with a value of personalWorkspace, limits the response to only those items in the user's workspaces. |
string or number 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. | |
| include | string Default: "" 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 |
| scopes | Array of strings If search fails, try using an array for each type of this comma-separated list of search filters. |
header Parameters
| Authorization | string API Access Token used to authenticate requests to Smartsheet APIs. Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789 |
Responses
Request samples
- cURL
- C#
- Java
- Node.js
- Python
- Ruby
curl 'https://api.smartsheet.com/2.0/search?query=stuff' \ -H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789"
Response samples
- 200
- default
{- "results": [
- {
- "objectId": 0,
- "parentObjectId": 0,
- "contextData": [
- "string"
], - "objectType": "string",
- "parentObjectName": "string",
- "parentObjectType": "string",
- "proofUrl": "string",
- "text": "string"
}
], - "totalCount": 0
}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. 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! Note Newly created or recently updated data may not be immediately discoverable via search.
path Parameters
| sheetId required | number Sheet Id of the sheet being accessed. |
query Parameters
| query required | string Text with which to perform the search. Enclose in double-quotes for an exact search. |
header Parameters
| Authorization | string API Access Token used to authenticate requests to Smartsheet APIs. Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789 |
Responses
Request samples
- cURL
- C#
- Java
- Node.js
- Python
- Ruby
curl 'https://api.smartsheet.com/2.0/search/sheets/{sheetId}?query=stuff' \ -H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789"
Response samples
- 200
- default
{- "results": [
- {
- "objectId": 0,
- "parentObjectId": 0,
- "contextData": [
- "string"
], - "objectType": "string",
- "parentObjectName": "string",
- "parentObjectType": "string",
- "proofUrl": "string",
- "text": "string"
}
], - "totalCount": 0,
- "result": [
- {
- "objectId": 0,
- "parentObjectId": 0,
- "contextData": [
- "string"
], - "objectType": "string",
- "parentObjectName": "string",
- "parentObjectType": "string",
- "proofUrl": "string",
- "text": "string"
}
]
}