Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
search

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!

get/search

Query parameters

querystring required

Text with which to perform the search.

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

locationstring

Deprecated When specified with a value of personalWorkspace, limits the response to only those items in the user's workspaces.

string date-time
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'favoriteFlag'

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
scopesstring[]

If search fails, try using an array for each type of this comma-separated list of search filters.

Response

Object that contains an array of matching items and the total count of those items.

totalCountnumber

Total number of search results in the results array.

Example response

{
  "results": [
    {
      "objectType": "row",
      "objectId": 12345678,
      "favorite": true
    }
  ],
  "totalCount": 1
}