API ReferenceSearch

Core Search

Searches for records based on a given query.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

querystringRequiredformat: "text"

The query string. Search query language: https://docs.devrev.ai/product/search#fields

cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
limitintegerOptional
The maximum number of items to return in a page. The default is '10'.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values:
namespaceslist of enumsOptional
The namespaces to search in.
sort_byenumOptional
The property on which to sort the search results. The default is RELEVANCE.
Allowed values:
sort_orderenumOptional
Sorting order. The default is DESCENDING.
Allowed values:

Response

Search response.
resultslist of objects
The search results.
cursorstring or nullformat: "text"
The cursor from where to begin iteration. Start from beginning if not provided.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors