English
Query Custom Object Details
About 157 wordsLess than 1 minute
2026-01-29
Description
Query custom object details
Request Specification
HTTP Method :POST + application/json
Request Path :https://${cloud domain}/cgi/crm/custom/v2/data/get?thirdTraceId=${random string}
Request Headers :Refer to Common Parameters
Note: This API only applies to custom objects (objects whose ApiName ends with __c)
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's apiName |
| objectDataId | String | No | Data ID |
Request Example
{
"includeNull": true,
"data": {
"dataObjectApiName": "",
"objectDataId": "hello"
}
}Response Parameters
| Parameter | Type | Description |
|---|---|---|
| traceId | string | Unique request ID |
| errorDescription | string | Error description |
| errorMessage | string | Error message |
| errorCode | Int | Error codes reference |
Response Example
{
"traceId": "E-O.827xxxxxx",
"errorDescription": "success",
"errorMessage": "OK",
"errorCode": 0
}Notes
- Do not use the message field in the response for logical judgment, as errorMessage may change;
