Box Search For Content
Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.
Write ActionRisk level 2 of 5OAuth connectionFree Action
Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.
sortDefines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is explicitly specified. * `relevance` (default) returns the results sorted by relevance to the query search term. The relevance is based on the occurr…
typestringLimits the search results to any items of this type. This parameter only takes one value. By default the API returns items that match any of these types. * `file` - Limits the search results to files * `folder` - Limits the search results to folders * `web_link` - Limits the sea…
limitintegerDefines the maximum number of items to return as part of a page of results.
querystringThe string to search for. REQUIRED unless 'mdfilters' is provided. Matched against item names, descriptions, text content, and other fields. Supports operators: "" (exact match), AND, OR, NOT (uppercase only).
scopestringLimits the search results to either the files that the user has access to, or to files available to the entire enterprise. The scope defaults to `user_content`, which limits the search results to content that is available to the currently authenticated user. The `enterprise_cont…
fieldsarrayA comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response u…
offsetintegerThe offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
directionstringDefines the direction in which search results are ordered. This API defaults to returning items in descending (`DESC`) order unless this parameter is explicitly specified. When results are sorted by `relevance` the ordering is locked to returning items in descending order of rel…
mdfiltersarrayMetadata filters to limit search results. REQUIRED unless 'query' is provided. A list specifying exactly one metadata template to filter by.
size_rangearrayLimits the search results to any items with a size within a given file size range. This applied to files and folders. Size ranges are defined as comma separated list of a lower and upper byte size limit (inclusive). The upper and lower bound can be omitted to create open ranges.
content_typesarrayLimits the search results to any items that match the search query for a specific part of the file, for example the file description. Content types are defined as a comma separated lists of Box recognized content types. The allowed content types are as follows. * `name` - The na…
trash_contentstringDetermines if the search should look in the trash for items. By default, this API only returns search results for items not currently in the trash (`non_trashed_only`). * `trashed_only` - Only searches for items currently in the trash * `non_trashed_only` - Only searches for ite…
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.