# Search everything

Searches all sheets that the user can access, for the specified text.

> Important: If you have't 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!

Endpoint: GET /search
Version: 2.0.0
Security: APIToken, OAuth2

## Header parameters:

  - `Authorization` (string)
    API Access Token used to authenticate requests to Smartsheet APIs.

  - `smartsheet-integration-source` (string)
    Uses the following metadata to distinguish between human-initiated API requests and third-party service-initiated calls by AI Connectors or ITSM:

- Integration source type
- Organization name
- Integration source name 

Format:


TYPE,OrgName,SourceName


Examples: 

AI,SampleOrg,My-AI-Connector-v2

SCRIPT,SampleOrg2,Accounting-updater-script

APPLICATION,SampleOrg3,SheetUpdater
    Example: "AI,SampleOrg,My-AI-Connector-v2"

## Query parameters:

  - `query` (string, required)
    Text with which to perform the search.

Tip: To match the exact text, wrap the query in double-quotes.

  - `modifiedSince` (any)
    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)
    When specified with a value of "favoriteFlag", the response indicates which returned items and item parents belong to the user's favorites.

Scenarios:

- If a matching item is a favorite, the search result for that item includes this property setting: "favorite": true
- If the parent of a matching item is a favorite, the search result for that item includes this property setting: "parentObjectFavorite": true
    Enum: "favoriteFlag"

  - `scopes` (array)
    If search fails, try using an array for each type of this comma-separated list of search filters.
    Enum: "attachments", "cellData", "comments", "folderNames", "reportNames", "sheetNames", "sightNames", "summaryFields", "templateNames", "workspaceNames"

  - `location` (string)
    Deprecated When specified with a value of personalWorkspace, limits the response to only those items in the user's workspaces.

## Response 200 fields (application/json):

  - `results` (array)
    Array of matching items.

  - `totalCount` (number)
    Total number of search results in the results array.
    Example: 1

## Response default fields (application/json):

  - `refId` (string)
    The ID of the specific error occurrence. Please include this information when contacting Smartsheet support.

  - `errorCode` (number)
    Custom error code from Smartsheet. See the complete [Error Code List](/api/smartsheet/error-codes).

  - `message` (string)
    Descriptive error message.