Execute single query

post

https://rls.congacloud.com/api/data/v1/custom-objects/query/{objectName}

Validates and executes the query request for the given custom object and specifying whether the total record count should be included in the response.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

objectName

string

required

Name of the custom object to which query needs to be processed.It can only contain underscores and alphanumeric characters and "_c" in the sufix. For example: CustomObject_c.

Query Params

IncludeTotalCount

boolean

Set to true to get the total count of records in response.

Note: Default value set to false.

after

string

Body Params

Actual query to be executed

Schema Model for Query

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

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request

403

Forbidden

Language

Credentials

Header

Loading…

Response

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

application/json

200OK