Docmost Octri Preview
POST/search/share-search

Search within a shared page tree

Searches the page tree of a public share for matching content. Supply query and shareId to search within that share; spaceId is ignored because the search is scoped to the shared page tree.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields

Search criteria and pagination options for searching within a public share.

limitintegeroptional
Maximum number of results to return.
offsetintegeroptional
Number of results to skip for pagination.
querystringrequired
Full-text search query.
shareIdstringrequired
ID of the share to search within. Results are restricted to pages in this share's page tree.
spaceIdstringoptional
Ignored — share search is scoped to the shared page tree regardless.

2 status codes
200Returns search results for the shared page tree.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when `shareId` is missing.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

query and shareId are required. A 400 is returned when shareId is missing.