search

Core Post

POST
Searches for records based on a given query.

Request

This endpoint expects an object.
query
stringRequired

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

cursor
stringOptional
The cursor from where to begin iteration. Start from beginning if not provided.
limit
integerOptional
The maximum number of items to return in a page. The default is '10'.
namespaces
list of enumsOptional
The namespaces to search in.
sort_by
enumOptional
Search sort by parameters.
Allowed values: created_datemodified_daterelevance
sort_order
enumOptional
Search sort order parameters.
Allowed values: ascdesc

Response

This endpoint returns an object
results
list of unions
The search results.
cursor
stringOptional
The cursor from where to begin iteration. Start from beginning if not provided.