Description

Query a list of lead objects based on specified conditions.

Request Specification

HTTP Method: POST + application/json

Request Path: https://${cloud domain}/cgi/crm/v2/data/query?thirdTraceId=${random string}

Request Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
includeNull	Boolean	No	Whether to include null fields. false: not returned, true: returned. Default is false
data	Map	Yes	Data map
dataObjectApiName	String	Yes	Object API name (fixed value: LeadsObj)
find_explicit_total_num	Boolean	No	Whether to return total count (true → returns total, false → skips total count. Default: true. Setting false improves response speed)
search_query_info	Map	Yes	Query Conditions
limit	Int	Yes	Pagination size (max: 100)
offset	Int	Yes	Offset (starts from 0, must be multiple of limit)
filters	List	Yes	Filter conditions
field_name	String	Yes	Field name
field_values	List[String]	Yes	Field values
operator	String	Yes	Operator (see Operator Parameters below)
orders	List	Yes	Sorting conditions
fieldName	String	Yes	Field name
isAsc	Boolean	Yes	Sort order (true: ascending, false: descending)
fieldProjection	List[String]	Yes	Return fields (use apiName from object fields)

Operator Parameters

Operators can be directly used from the object list page. See How to Get Query Conditions.

Parameter	Meaning	Description	Parameter	Meaning	Description
EQ	Equal		N	Not equal	Can query null values
GT	Greater than		GTE	Greater than or equal
LT	Less than		LTE	Less than or equal
LIKE	Contains		NLIKE	Does not contain
IS	Is null		ISN	Is not null
IN	Belongs to		NIN	Does not belong to
BETWEEN	Between		NBETWEEN	Not between
STARTWITH	Starts with		ENDWITH	Ends with
HASANYOF	Has overlapping elements		NHASANYOF	No overlap

Request Example

{
  "includeNull": true,
  "data": {
    "find_explicit_total_num": true,
    "search_query_info": {
      "offset": 0,
      "limit": 1,
      "orders": [
        {
          "fieldName": "create_time",
          "isAsc": true
        }
      ],
      "fieldProjection": [
        "name"
      ],
      "filters": [
        {
          "operator": "EQ",
          "field_name": "name",
          "field_values": [
            "603dabc14ae65400011aec90"
          ]
        }
      ]
    },
    "dataObjectApiName": "LeadsObj"
  },
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
data	Map	Detailed parameters (call Object Description API)
errorMessage	string	Error message
errorCode	Int	Error Codes

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "data": {
    "created_by__r": {},
    "lock_status": "0",
    "is_deleted": false,
    "create_time": 1612247399397,
    "name": "xxxxxx",
    "_id": "69046aexxxxxxx"
  },
  "errorMessage": "OK",
  "errorCode": 0
}

Notes

• Do not use the message field in response for logical judgments, as errorMessage may change.
• Empty-valued fields are omitted from the response.