Description

Query detailed information of a single lead object.

Request Specification

HTTP Method: POST + application/json

Request Path: https://${cloud domain}/cgi/crm/v2/data/get?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 apiName, fixed value: LeadsObj
objectDataId	String	Yes	Data ID

Request Example

{
  "includeNull": true,
  "data": {
    "dataObjectApiName": "LeadsObj",
    "objectDataId": "hello"
  },
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
data	Map	Parameter details (call Query 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 the response for logical judgment, as errorMessage may change;
• If a field's value is empty, it will not be returned;