Docmost Octri Preview
POST/search

Search pages by full text

Searches page titles and content using a full-text query. Use spaceId to restrict results to a space and creatorId to filter by the user who created the pages. Use offset and limit to paginate the results.

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

5 body fields

Search criteria and optional filters for pages.

creatorIdstringoptional
Filter results to pages created by a specific user.
limitintegeroptional
Maximum number of results to return.
offsetintegeroptional
Number of results to skip for pagination.
querystringrequired
Full-text search query. Searches page titles and content.
spaceIdstringoptional
Restrict search results to a specific space. If omitted, searches across all spaces the user has access to.

3 status codes
200Returns search results with associated space information.
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Returned when the required query is missing or the request fails validation.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when the authenticated user is not permitted to search the requested scope.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when the required query is missing or the request fails validation. A 403 is returned when the authenticated user is not permitted to search the requested scope; omit spaceId to search across spaces the user can access.