Global Search on configured objects

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The global search request containing search term, object list, pagination settings, and exclude object options (via ExcludeObjectList).

Global Search Request

SearchTerm

string | null

The search term or keyword to search across objects. Used for search operations.

PhraseSearch

boolean | null

Flag indicating phrase search mode.
If true, the search term will be treated as an exact phrase, and results will only include records that match the entire phrase.

ObjectList

array of objects | null

List of objects to be searched along with their specific search criteria, filters, and field selections.
Each entry in this list represents a separate object query with its own configuration.

ObjectList

Skip

int32

The number of records to skip for pagination. Used in conjunction with Limit to implement paging.
Default is 0 if not specified.

Limit

int32

The maximum number of records to return per page. Used for pagination along with Skip.
Default page size applies if not specified.

ExcludeObjectList

array of strings | null

List of object identifiers or names to exclude from the global search operation.
Any objects specified here will be omitted from search results, even if they appear in ObjectList or defaults.

ExcludeObjectList

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