authoring-search
Search the Sitecore authoring index by criteria (MUST/SHOULD/NOT) to return matching items by field, template, or path; read entire subtrees in one query.
Instructions
Searches a Sitecore index over the Authoring and Management API and returns matching items. Criteria combine on the operator you give each one: MUST is AND, SHOULD is OR, NOT excludes. Useful system fields: '_name', '_fullpath' (the item path), '_path' (matches items under an ancestor, given that ancestor's ID with no braces or dashes), '_template' and '_templatename'. IDs in index values are lowercase and unpunctuated, e.g. '110d559fdea542ea9c1c8a5df7e70ef9'. Returns 10 results unless pageSize says otherwise. A '_path' criterion is the cheap way to read a whole subtree at any depth — one query where item-service-get-item-descendants makes one request per node — at the cost of returning identity fields rather than field values, from the index rather than the database.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | The index to search. Defaults to sitecore_master_index (the authoring content). | sitecore_master_index |
| criteria | Yes | The criteria to match. At least one. | |
| language | No | Restrict results to this language, e.g. 'en'. | |
| pageSize | No | Results per page. The endpoint's own default is 10. | |
| pageIndex | No | Zero-based page to return. Use with pageSize to walk a large result set. | |
| sortField | No | Field to sort by, e.g. '__smallcreateddate'. Omit for relevance order. | |
| sortDirection | No | Sort direction. Only meaningful with sortField. | |
| latestVersionOnly | No | When true, return only the latest version of each item instead of every indexed version. |