Search documents

post

https://rls.congacloud.com/api/search/v1/document/query

Searches an object using various query parameters (for example, Advanced, Fulltext, and Typeahead) and returns the results along with a count.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

objectName

string

Document object for which the query needs to be executed.

IncludeTotalCount

boolean

IsRefreshFromDB

boolean

Body Params

Query to be executed.

ObjectName

string | null

Name of object on which querying needs to be done.

Criteria

string | null

Select

array of strings | null

The fields which are to be displayed.

Select

Distinct

boolean

Select true to get distinct records

Limit

int32 | null

Limit set for records to be fetched. For example: Limit = 100, This will fetch 100 records matching the criteria.

Skip

int32 | null

Number of records to be skipped.

Sort

object

Sort information for records.

GroupBy

array of strings | null

List of field names which are to be grouped.

GroupBy

SearchType

string | null

AdditionalTypeAheadFilterCriteria

string | null

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request

404

Not Found

500

Internal Server Error

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success