API ReferenceSearch

Core Search (POST)

Searches for records based on a given query.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
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. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

Allowed values:
namespaceslist of enumsOptional
The namespaces to search in.
sort_byenumOptional
Search sort by parameters.
Allowed values:
sort_orderenumOptional
Search sort order parameters.
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