Description

Query object list

Request Specification

Request Method: POST + application/json

Request Path: https://${Cloud Domain}/cgi/crm/v2/object/list?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

Request Example

{
  "includeNull": true,
}

Response Parameters

Parameter	Type	Description
traceId	string	Request unique ID
errorDescription	string	Error description
data	Map	Response dataset
objects	List	Object list

Response Example

{
  "traceId": "E-O.cdklrj.2121-20251124113618-b6a1cb",
  "errorDescription": "success",
  "data": {
    "objects": [
      {
        "describeApiName": "MarketingEventObj",
        "describeDisplayName": "Marketing Event",
        "defineType": "package",
        "isActive": true,
        "hideButton": false,
        "publicObject": false
      },
      {
        "describeApiName": "CampaignMembersObj",
        "describeDisplayName": "Campaign Members",
        "defineType": "package",
        "isActive": true,
        "hideButton": false,
        "publicObject": false
      },
      {
        "describeApiName": "LeadsObj",
        "describeDisplayName": "Leads",
        "defineType": "package",
        "isActive": true,
        "iconPath": "",
        "iconIndex": 0,
        "hideButton": false,
        "publicObject": false
      },
      {
        "describeApiName": "BehaviorRecordObj",
        "describeDisplayName": "Behavior Record",
        "defineType": "package",
        "isActive": true,
        "hideButton": false,
        "publicObject": false
      },
      {
        "describeApiName": "AccountObj",
        "describeDisplayName": "Account",
        "defineType": "package",
        "isActive": true,
        "iconPath": "",
        "iconIndex": 0,
        "hideButton": false,
        "publicObject": false
      },
      {
        "describeApiName": "ContactObj",
        "describeDisplayName": "Contact",
        "defineType": "package",
        "isActive": true,
        "iconPath": "",
        "iconIndex": 0,
        "hideButton": false,
        "publicObject": false
      }
    ]
  }
}